Add --help output to README
This commit is contained in:
parent
a04625683c
commit
d834964d4e
17
README.rst
17
README.rst
|
@ -8,6 +8,23 @@ pystitcher stitches your PDF files together, generating nice customizable bookma
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
|
pystitcher is a command line tool, with very few cli options::
|
||||||
|
|
||||||
|
usage: pystitcher [-h] [--version] [-v] [--cleanup | --no-cleanup] spine.md output.pdf
|
||||||
|
|
||||||
|
Stitch PDF files together
|
||||||
|
|
||||||
|
positional arguments:
|
||||||
|
spine.md Input markdown file
|
||||||
|
output.pdf Output PDF file
|
||||||
|
|
||||||
|
optional arguments:
|
||||||
|
-h, --help show this help message and exit
|
||||||
|
--version show program's version number and exit
|
||||||
|
-v, --verbose log more things
|
||||||
|
--cleanup, --no-cleanup
|
||||||
|
Delete temporary files (default: True)
|
||||||
|
|
||||||
Given this input::
|
Given this input::
|
||||||
|
|
||||||
existing_bookmarks: flatten
|
existing_bookmarks: flatten
|
||||||
|
|
Loading…
Reference in New Issue