Overview

.. -*- restructuredtext -*-

==================
README for Rex
==================

Installing
==========

Use ``setup.py``::

   python setup.py build
   sudo python setup.py install


Reading the docs
================

After installing::

    ./mkdoc

Then, direct your browser to ``docs/build/html/index.html``.

Or read them online at <http://rex.readthedocs.org/>.


Testing
=======

To run the tests with the interpreter available as ``python``, use::

    make test