#
# pyAwale - A simple Awalé game
# The count-and-capture official board game of Africa.
#

Installation
============

Requirements
------------

Install Python_ 2.3 or later. 

.. _Python: http://python.org

To play with the graphic interface, install Pygame_ library too.

.. _Pygame: http://pygame.org

Optionally, install Psyco_ module to speed up the execution.

.. _Psyco: http://psyco.sourceforge.net

Install manually
----------------

If you'd rather do the installation manually, simply decompress the
sources ``pyawale-x.x.x`` in a directory and launch script
``src/pyawale.py`` to play::

  $ python -O src/pyawale.py --help

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

In order to generate the documentation, you need to install the
Docutils_ package.

.. _Docutils: http://docutils.sourceforge.net

The documention have bben written in ReStructuredText_ format;

.. _ReStructuredText: http://docutils.sourceforge.net/rst.html

So, to generate documentation in ``html`` format, enter the command::

  $ rst2html -g -s -t pyawale.rest pyawale.html

PS: All documentation files (README, INSTALL, ...) have been written
with this format, so, you can apply the same method on these files.

-- 
MiKael NAVARRO