Go to file
Jonas Borgström 445b862d8c Added more installation documentation. 2013-06-30 21:30:17 +02:00
darc Added hashindex test cases and removed unused BandIndex 2013-06-29 14:25:02 +02:00
docs Added more installation documentation. 2013-06-30 21:30:17 +02:00
scripts setup.py: switch from setuptools to pure distutils 2012-02-29 23:30:24 +01:00
.gitignore Packaging improvements 2013-06-24 13:53:02 +02:00
COPYING Packaging improvements 2013-06-24 13:53:02 +02:00
README Updated README 2011-11-06 17:28:32 +01:00
setup.py Minor setup.py fix 2013-06-27 23:03:48 +02:00
tox.ini More xattr code cleanup 2013-06-27 22:10:15 +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