Improved documentation
1 files changed, 18 insertions(+), 1 deletions(-)

M README.rst
M README.rst +18 -1
@@ 1,8 1,22 @@ 
 ============
 jpeg swapper
 ============
+Swaps blocks of jpeg file. Or more like crop and overlay. Used to "descramble" image files obtained from certain online "book" readers.
 
-Swaps blocks of jpeg file. Or more like crop and overlay. Used to "descramble" image files obtained from certain online "book" readers.
+
+Requirements
+------------
+``jpeg`` library which contains tool ``jpegtran``, patched with ``drop`` extension.
+
+- |jpeg_library|_
+- |drop_patch|_
+
+.. |jpeg_library| replace:: `jpeg` library
+.. _jpeg_library: http://www.ijg.org/files/jpegsrc.v9b.tar.gz
+
+.. |drop_patch| replace:: `drop` patch
+.. _drop_patch: http://jpegclub.org/droppatch.v9b.tar.gz
+
 
 ``crop``
 --------

          
@@ 10,6 24,7 @@ Given a directory with jpeg files (``<na
 
 Edit the ``crop`` command to adjust number of rows and columns and its size. Hopefully in multiplication of 8.
 
+
 ``overlay <mapping> <filename>``
 ---------------------------------
 Run with ``<filename>`` pointing to previously moved file ``<name>.jpg`` in ``<name>-split`` directory, given a ``<mapping>`` file with content like this:

          
@@ 21,6 36,7 @@ Run with ``<filename>`` pointing to prev
 
 It will overlay the cropped files to a copy of source file named ``<name>-ok.jpg``.
 
+
 Misc
 ----
 Clearly needs improvement:

          
@@ 29,6 45,7 @@ 1. Swap in one command. And for one file
 2. The command should accept block size and number or columns and rows.
 3. Create a mapping file generator. Ideally some GUI which accepts ``jpeg`` image, followed by entering number of columns and rows and size of the block. Or maybe automatically guess the blocks. Then allow user to swap around the image either by drag and drop or pair of clicks.
 
+
 License
 -------
 ::