From 1865f2e04f87f59f02cf33d90b36686ef5eac062 Mon Sep 17 00:00:00 2001 From: jevans Date: Thu, 27 Jun 2013 19:25:11 -0400 Subject: [PATCH] Minor doc changes. --- docs/source/detailed_installation.rst | 7 ++----- docs/source/introduction.rst | 8 ++++---- docs/source/roadmap.rst | 2 +- 3 files changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/source/detailed_installation.rst b/docs/source/detailed_installation.rst index 4c11fc2..5090cdc 100644 --- a/docs/source/detailed_installation.rst +++ b/docs/source/detailed_installation.rst @@ -59,10 +59,7 @@ repositories:: Raspbian '''''''' Yeah, this was the first thing I tried after getting my new Raspberry Pi hooked -up. This doesn't seem like the sort of thing that the Raspberry Pi was built -for, as it took nearly an hour just to run the OpenJPEG tests, but still, I -couldn't help myself but give it a try :-) -Raspbian ships with Python 3.2 and 2.7, so these steps detail working with 2.7. +up (couldn't help myself :-) Raspbian ships with Python 3.2 and 2.7, so these steps detail working with 2.7. Additional required OS packages include:: @@ -77,7 +74,7 @@ install the following debs:: * python-dev * python-matplotlib -and then install Pillow via pip. The tests take about 20 minutes to run, with +and then install Pillow via pip. The tests take about 30 minutes to run, with one unexpected failure as of the time of writing. Fedora 17 diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index 834ecc7..f8d4c65 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -50,7 +50,7 @@ the openjp2 library. You may create the configuration file as follows:: > EOF That assumes, of course, that you've installed OpenJPEG into /opt/openjp2-svn. -You may also replace **$HOME/.config** with **$XDG_CONFIG_HOME**. +You may also substitute **$XDG_CONFIG_HOME** for **$HOME/.config**. Glymur Installation =================== @@ -59,12 +59,12 @@ You can retrieve the source for Glymur from either of * https://pypi.python.org/pypi/Glymur/ (stable releases) * http://github.com/quintusdias/glymur (bleeding edge) -but you should now be able to get a functional installation of Glymur via -pip :: +but you should also be able to install Glymur via pip :: $ pip install glymur -This will install the **jp2dump** script, so you should adjust your **$PATH** +This will install the **jp2dump** script that can be used from the unix command +line, so you should adjust your **$PATH** to take advantage of it. For example, if you install with pip's `--user` option on linux :: diff --git a/docs/source/roadmap.rst b/docs/source/roadmap.rst index a6f967a..ea4a5bd 100644 --- a/docs/source/roadmap.rst +++ b/docs/source/roadmap.rst @@ -6,7 +6,7 @@ Here's an incomplete list of what I'd like to focus on in the near future. * continue to monitor upstream changes in the openjp2 library * investigate using CFFI or cython instead of ctypes to wrap openjp2 + * investigate swapping out ElementTree for LXML * eventually expose the openjp2 API - * add metadata support for ICC profiles * investigate JPIP