========
Vengeance
========
Vengeance is a text-based adventure game engine created as an exercise in
Python backward compatibility.

Prerequisites
=============
Vengeance does not depend on any libraries at runtime.

Building and Installing
=======================
To build Vengeance you will need to install:

* Pylint (``pip install pylint``)
* PEP8 (``pip install pep8``)
* Sphinx (``pip install Sphinx``)

To build, check, package, install and test Vengeance, run the ``test`` script:

    ./test

Examples
========
See example game in ``bin/example_game.py``. This can be run simply with:

    python bin/example_game.py
========
Vengeance
========
Vengeance is a text-based adventure game engine created as an exercise in
Python backward compatibility.

Prerequisites
=============
Vengeance does not depend on any libraries at runtime.

Building and Installing
=======================
To build Vengeance you will need to install:

* Coverage (``pip install coverage``)
* Pylint (``pip install pylint``)
* PEP8 (``pip install pep8``)
* Sphinx (``pip install Sphinx``)

To build, check, package, install and test Vengeance, run the ``test`` script:

    ./test

Examples
========
See example game in ``bin/example_game.py``. This can be run simply with:

    python bin/example_game.py
Add details of dependency on coverage to readme
Add details of dependency on coverage to readme
