From 7c255b2babe4602f4b5416fd70a78cc421af1d07 Mon Sep 17 00:00:00 2001 From: Pelle Nilsson Date: Tue, 4 Jun 2013 00:27:32 +0200 Subject: [PATCH] Usage documentation. --- formatgamebook.py | 2 +- readme.org | 13 +++++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/formatgamebook.py b/formatgamebook.py index 58caa0e..a0910ab 100755 --- a/formatgamebook.py +++ b/formatgamebook.py @@ -140,7 +140,7 @@ if __name__ == '__main__': dest='import_default_map_file', help='ignore default map file') ap.add_argument('-t', '--template', metavar='D', dest='templatedirs', - action='append', help='Add custom template dir') + action='append', help='add custom template dir') args = ap.parse_args() templatedirs = ['templates', os.path.join(os.path.dirname(sys.argv[0]), 'templates')] diff --git a/readme.org b/readme.org index 80ec91a..2094689 100644 --- a/readme.org +++ b/readme.org @@ -3,6 +3,19 @@ A tool to format [[http://www.gamebooks.org/][gamebooks]] into various formats useful for playing the gamebook on paper or a screen (or for debugging it). +** Usage +: formatgamebook.py [-h] [-M] [-t D] inputfile [inputfile ...] outputfile +: +: positional arguments: +: inputfile input gamebook file (eg test.json) +: outputfile output file (eg test.tex or test.rtf) +: +: optional arguments: +: -h, --help show this help message and exit +: -M, --no-default-map ignore default map file +: -t D, --template D add custom template dir + + ** Supported Output Formats | Name | Extension | Description |