borg/README

42 lines
592 B
ReStructuredText

.. -*- 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