2011-11-06 16:28:32 +00:00
|
|
|
.. -*- restructuredtext -*-
|
2010-10-27 18:40:48 +00:00
|
|
|
|
2011-11-06 16:28:32 +00:00
|
|
|
===============
|
|
|
|
|
README for Darc
|
|
|
|
|
===============
|
2010-10-27 18:40:48 +00:00
|
|
|
|
2011-11-06 16:28:32 +00:00
|
|
|
Installing
|
|
|
|
|
==========
|
2010-10-27 18:40:48 +00:00
|
|
|
|
2011-11-06 16:28:32 +00:00
|
|
|
Use ``setup.py``::
|
2010-10-27 18:40:48 +00:00
|
|
|
|
2011-11-06 16:28:32 +00:00
|
|
|
python setup.py build
|
|
|
|
|
sudo python setup.py install
|
2010-10-27 18:40:48 +00:00
|
|
|
|
|
|
|
|
|
2011-11-06 16:28:32 +00:00
|
|
|
Reading the docs
|
|
|
|
|
================
|
2010-10-27 18:40:48 +00:00
|
|
|
|
2011-11-06 16:28:32 +00:00
|
|
|
After installing::
|
2010-10-27 18:40:48 +00:00
|
|
|
|
2011-11-06 16:28:32 +00:00
|
|
|
cd docs
|
|
|
|
|
sphinx-build . _build/html
|
2010-10-27 18:40:48 +00:00
|
|
|
|
2011-11-06 16:28:32 +00:00
|
|
|
Then, direct your browser to ``_build/html/index.html``.
|
2010-10-27 18:40:48 +00:00
|
|
|
|
2011-11-06 16:28:32 +00:00
|
|
|
Or read them online at <http://jborg.github.com/darc/>.
|
2010-10-27 18:40:48 +00:00
|
|
|
|
|
|
|
|
|
2011-11-06 16:28:32 +00:00
|
|
|
Testing
|
|
|
|
|
=======
|
2010-10-27 18:40:48 +00:00
|
|
|
|
2011-11-06 16:28:32 +00:00
|
|
|
To run the tests with the interpreter available as ``python``, use::
|
2010-10-27 18:40:48 +00:00
|
|
|
|
2011-11-06 16:28:32 +00:00
|
|
|
$ python -m darc.test
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Contributing
|
|
|
|
|
============
|
|
|
|
|
|
|
|
|
|
Send wishes, comments, patches, etc. to jonas@borgstrom.se
|
2010-10-27 18:40:48 +00:00
|
|
|
|
