README 592 B

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. .. -*- restructuredtext -*-
  2. ===============
  3. README for Darc
  4. ===============
  5. Installing
  6. ==========
  7. Use ``setup.py``::
  8. python setup.py build
  9. sudo python setup.py install
  10. Reading the docs
  11. ================
  12. After installing::
  13. cd docs
  14. sphinx-build . _build/html
  15. Then, direct your browser to ``_build/html/index.html``.
  16. Or read them online at <http://jborg.github.com/darc/>.
  17. Testing
  18. =======
  19. To run the tests with the interpreter available as ``python``, use::
  20. $ python -m darc.test
  21. Contributing
  22. ============
  23. Send wishes, comments, patches, etc. to jonas@borgstrom.se