Updated readme for building documentation.

This commit is contained in:
John Evans 2013-05-27 07:44:48 -04:00
commit d765af38a6

View file

@ -0,0 +1,13 @@
=========================================
glymur: a Python interface for JPEG 2000
=========================================
**glymur** contains a Python interface to the OpenJPEG library
which allows linux and mac users to read and write JPEG 2000 files.
**glymur** works on Python 2.7 and 3.3. Python 3.3 is strongly recommended.
Until I figure out how to get readthedocs.org to handle numpydoc, you'll have
to do as follows to build the documentation first::
$ make -C docs html
$ open docs/build/html/index.html