From d834964d4e80d7a745ca6825e31527d01097c090 Mon Sep 17 00:00:00 2001 From: Nemo Date: Sat, 29 May 2021 00:34:36 +0530 Subject: [PATCH] Add --help output to README --- README.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.rst b/README.rst index 3a8b9a4..65a4a6c 100644 --- a/README.rst +++ b/README.rst @@ -8,6 +8,23 @@ pystitcher stitches your PDF files together, generating nice customizable bookma 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:: existing_bookmarks: flatten