1
0
Fork 0
mirror of https://github.com/Oreolek/gamebookformat.git synced 2024-06-16 15:10:45 +03:00

Usage documentation.

This commit is contained in:
Pelle Nilsson 2013-06-04 00:27:32 +02:00
parent 8a4a3401b4
commit 7c255b2bab
2 changed files with 14 additions and 1 deletions

View file

@ -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')]

View file

@ -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 |