added improved commandline documentation to the readme. Fixes #14

deborahgu · Nov 1, 2017 · 5517820 · 5517820
1 parent c0f4be0
commit 5517820
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -36,7 +36,7 @@ Requirements
 
 * Python 3
 * If running epubcheck, a Java Runtime environment
-* If running DAISY Ave, Node.js
+* If running DAISY Ace, Node.js
 
 Usage
 =====
@@ -53,7 +53,26 @@ From the shell:
 
 .. code:: bash 
 
-     python bin/create_epub.py styleliterarymet00cadb
+     abbyy2epub docname     # See *Assumptions* below.
+
+The available command line arguments are:
+
+..code:: bash
+
+    usage: abbyy2epub [-h] [-d] [--epubcheck] [--ace] docname
+
+    Process an ABBYY file into an EPUB
+
+    positional arguments:
+      docname      A directory containing all the necessary files. See the README
+                   for details.
+
+    optional arguments:
+      -h, --help   show this help message and exit
+      -d, --debug  Show debugging information
+      --epubcheck  Run EpubCheck on the newly created EPUB
+      --ace        Run DAISY Ace on the newly created EPUB
+
 
 System dependencies
 ===================

diff --git a/requirements.txt b/requirements.txt
@@ -6,6 +6,6 @@ pillow==4.2.1
 PyExecJs>=1.4.1
 pytest>=3.2.2
 numeral>=0.1.0.11
-six==10.0.0
+six==1.10.0
 sphinx>=1.6.0
 sphinx-autobuild