=====================
README for GrapeFruit
=====================

Installing
============

**From the sources:**

Download the latest grapefruit library from:

  http://code.google.com/p/grapefruit/


Untar the source distribution and run::

  $ python setup.py build
  $ python setup.py install


Testing
=========

With setuptools installed::

  $ python setup.py test

Without setuptools installed::

  $ python grapefruit_test.py


Getting the code
==================

View the trunk at:

  http://grapefruit.googlecode.com/svn/trunk/

Check out the latest development version anonymously with::

  $ svn checkout http://grapefruit.googlecode.com/svn/trunk/ GrapeFruit

Documentation
===============

You can download a compiled version of the documentation at:

  http://http://code.google.com/p/grapefruit/downloads/list?q=label:Type-Docs

The documentation is generated from reStructuredText sources by Sphinx.
If you need to build it, go into the doc folder and run::

  make <builder>

Or, if you're running windows::

  makedoc.cmd


License
=========

::

  Copyright (c) 2008, Xavier Basty
  
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at
  
  http://www.apache.org/licenses/LICENSE-2.0
  
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.