From a6dc04f165363a9bca8d13c273fdda6dc0e3807a Mon Sep 17 00:00:00 2001 From: rudism Date: Mon, 27 Jul 2015 17:41:49 -0500 Subject: [PATCH] added info about debug flag --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ba82f1f..5e9516b 100644 --- a/README.md +++ b/README.md @@ -41,23 +41,23 @@ Running ficdown.exe without any arguments will produce the following help text: Options surrounded by square brackets are optional, everything else is required. It should be noted that while the help text shows Linux-style paths, these will not work on Windows. On Windows you should pass regular paths as you normally would (for example `--in "C:\Users\Me\Documents\MyStory.md`). -#### format +#### --format Can be either `html` or `epub`. -#### in +#### --in Should be the absolute or relative path to your Ficdown story file. -#### out +#### --out You can specify either the absolute or relative path of the epub file to generate when `format` is `epub`, or the absolute or relative path of the directory to create when `format` is `html`. -#### template +#### --template You can optionally specify a custom HTML template to use when generating the HTML or epub documents. The template directory should contain three files: [index.html](/Ficdown.Parser/Render/Views/index.html), [scene.html](/Ficdown.Parser/Render/Views/scene.html), and [styles.css](/Ficdown.Parser/Render/Assets/styles.css). Those link to the default files used if no custom template is specified (which have been optimized for simple epub formatting). -#### images +#### --images If your story contains images, you must place them all into a directory and then include the absolute or relative path to that directory here. Due to the nature of epub documents, images cannot be linked to from subdirectories in your story--you must always link to them as though they are located in the same directory as the Ficdown file. For example, this is good Markdown syntax for including images in your story: @@ -75,10 +75,14 @@ The following would not work, even if your images directory contains the `stuff` ![My Image](stuff/myimage.png) -#### author +#### --author This option is required if your `format` is `epub` for the ebook metadata. It is ignored for `html`. +#### --debug + +If you pass this option, all of the pages in your story will include output at the bottom showing you what the current player state looks like (a list of all state variables that have been toggled and are used in scenes that the player can still reach). This can be useful if you discover that your compiled story does not behave the way you expected it to. + ## Other Formats To generate other formats than HTML or epub, you will have to use third party tools. [Calibre](http://www.calibre-ebook.com) is a popular ebook management suite that includes the ability to convert books from almost any format to any other format. Also, Amazon has an official tool called [KindleGen](http://www.amazon.com/gp/feature.html?docId=1000765211) that you can use to convert your epub to a format that can be read on Kindles.