From d765af38a66e9e5953080d698a80ffa2d81dfe85 Mon Sep 17 00:00:00 2001 From: John Evans Date: Mon, 27 May 2013 07:44:48 -0400 Subject: [PATCH] Updated readme for building documentation. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index e69de29..b362bb1 100644 --- a/README.md +++ b/README.md @@ -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