Commit 1f0ad69d authored by aggsol's avatar aggsol 🙉

updated readme

parent 8188d143
......@@ -8,12 +8,32 @@ Helper tool for gamebooks written in Asciidoc
1. Enforce `+` at the end of section lines?
2. Better test cases
3. Better documentation
## Usage
```
Options:
-i, --input <file> Input file in Asciidoctor format
-o, --output <file> Output file, default is stdout
-s, --seed <number> Shuffle seed, default: 12345
Flags:
-d, --dot-file Create a dot file named graph.dot
-h, --help Show this help text
-m, --mix-sections Shuffle the sections
-n, --no-color Disable colored output
-v, --verbose Show additional information
--version Show version
```
## Build
Tested only on Ubuntu with `g++ 7.3.0` and `clang++ 6.0.1` (Sorry!)
### Requirements
1. C++ compiler
1. C++14 compiler
2. Asciidoctor (to generate the book)
3. Graphiz dot (to generate graphs)
......@@ -35,12 +55,17 @@ $ ./gamebook-checker --input ../example/sections.adoc
Generate a graph
```
$ ./gamebook-checker --dot --input ../example/sections.adoc
$ dot -Tpng graph.dot > shuffled.png
$ dot -Tpng graph.dot > graph.png
```
Mix sections
```
$ ./gamebook-checker --mix-sections --input ../example/sections.adoc --output mixed.adoc
```
## Format
Subset of Asciidoc.
Subset of [Asciidoc](http://asciidoc.org/) is used to write the gamebook.
### Book
......@@ -88,10 +113,11 @@ Tags of sections helps to debug and naviagte the story quickliy with the generat
## How to Build the Book
* Use a Makfile
* Makefile to build your book
* Asciidoctor to create HTML and docbook format
* Pandoc to create DOCS from HTML
* Calibre to create ePub and Mobi from HTML
* Pandoc to create DOCX from HTML (Is this a good idea?)
* Calibre to create ePub, Mobi and PDF from HTML
* TODO: How are ebooks created from docbook?
## Best Practices
......@@ -100,8 +126,6 @@ Tags of sections helps to debug and naviagte the story quickliy with the generat
3. Fix plot holes asap
4. Write related sections together
## Shuffle Sections
## Licenses
* gamebook-checker is GPLv3
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment