Go to file
Jonas Borgström c0d7934986 Added fake_pyrex/README 2011-11-06 17:33:55 +01:00
darc change-password improvements 2011-11-01 21:00:21 +01:00
docs Improved documentation 2011-11-06 16:59:14 +01:00
fake_pyrex Added fake_pyrex/README 2011-11-06 17:33:55 +01:00
.gitignore Initial documentation 2011-11-05 19:43:23 +01:00
README Updated README 2011-11-06 17:28:32 +01:00
setup.py Fix setuptools Cython issue 2011-11-05 21:13:15 +01:00

README

.. -*- restructuredtext -*-

===============
README for Darc
===============

Installing
==========

Use ``setup.py``::

   python setup.py build
   sudo python setup.py install


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

After installing::

   cd docs
   sphinx-build . _build/html

Then, direct your browser to ``_build/html/index.html``.

Or read them online at <http://jborg.github.com/darc/>.


Testing
=======

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

	$ python -m darc.test


Contributing
============

Send wishes, comments, patches, etc. to jonas@borgstrom.se