tupdated readme with usage cmd - cross-stitch - interactively turn images into patterns for cross stitching
(HTM) git clone git://src.adamsgaard.dk/cross-stitch
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) LICENSE
---
(DIR) commit 2a467544ba8dc18921d1e35d598c48c591d2793b
(DIR) parent b6cf99404168086ce010f29a8a3de22659f8465a
(HTM) Author: Anders Damsgaard <anders.damsgaard@geo.au.dk>
Date: Thu, 13 Feb 2014 22:22:32 +0100
updated readme with usage cmd
Diffstat:
M README.rst | 17 ++++++++++++++---
M generate-readme.sh | 4 +---
2 files changed, 15 insertions(+), 6 deletions(-)
---
(DIR) diff --git a/README.rst b/README.rst
t@@ -29,7 +29,20 @@ Usage
-----
-./cross-stitch.py -h
+usage: cross-stitch.py [-h] --infile FILENAME --outfile FILENAME
+ [--width WIDTH]
+
+Downsamples and modifies an image in order to create a pattern for cross
+stitching.
+
+optional arguments:
+ -h, --help show this help message and exit
+ --infile FILENAME, -i FILENAME
+ input image to process
+ --outfile FILENAME, -o FILENAME
+ save processed image as FILENAME
+ --width WIDTH, -w WIDTH
+ canvas width, default value = 20
Example
-------
t@@ -39,11 +52,9 @@ Example
.. image:: fiskeren.jpg
:scale: 50 %
:alt: Original image
- :align: left
.. image:: fisker-pattern.png
:scale: 60 %
:alt: Cross stitching pattern
- :align: right
(DIR) diff --git a/generate-readme.sh b/generate-readme.sh
t@@ -36,7 +36,7 @@ Usage
echo "Generating $1"
echo "$HEADER" > $1
-echo ./cross-stitch.py -h >> $1
+echo "`./cross-stitch.py -h`" >> $1
EXAMPLE="
Example
t@@ -47,12 +47,10 @@ Example
.. image:: fiskeren.jpg
:scale: 50 %
:alt: Original image
- :align: left
.. image:: fisker-pattern.png
:scale: 60 %
:alt: Cross stitching pattern
- :align: right
"