yummy / INSTALL

**yummy** Installation Instructions

This section contains information about 
how to download and install **yummy ** in your system. 
It also contains brief instructions about how
to build the included documentation.


Detailed information about the minimum supported Python modules
 that may be required in order to run this software is shown below:

.. literalinclude:: ../requirements.txt

This information exists in the ``requirements.txt`` file 
inside the ** yummy ** distribution package. 
If ``pip`` is used to install this software,
then all these dependencies will also be installed, 
if they are not already installed in your system.


Got to

URL is


To install **yummy** from soruce code, use the provided installation script::

    python install

Or it is also possible to install this application directly from
the `source code repository`_ using ``pip``::

    pip install -e hg+

The above command will install the latest development release of **yummy**.

How to build the documentation

This project's documentation is located in source form under the ``docs``
directory. In order to convert the documentation to a format that is
easy to read and navigate you need the ``sphinx`` package.

You can install ``sphinx`` using ``pip``::

    pip install sphinx

Or ``easy_install``::

    easy_install sphinx

Once ``sphinx`` is installed, change to the ``docs`` directory, open a shell
and run the following command::

    make html

This will build a HTML version of the documentation. You can read the
documentation by opening the following file in any web browser::