Go to file
Jonas Borgström 3e5433855c Use Cython for all native code 2013-05-31 14:08:02 +02:00
darc Use Cython for all native code 2013-05-31 14:08:02 +02:00
docs Rename purge command to prune 2011-11-22 21:47:17 +01:00
fake_pyrex Added fake_pyrex/README 2011-11-06 17:33:55 +01:00
scripts setup.py: switch from setuptools to pure distutils 2012-02-29 23:30:24 +01:00
.gitignore Use Cython for all native code 2013-05-31 14:08:02 +02:00
README Updated README 2011-11-06 17:28:32 +01:00
setup.cfg Bumped version number 2011-11-06 21:40:29 +01:00
setup.py Use Cython for all native code 2013-05-31 14:08:02 +02: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