vagabond/sapling
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update documentation

Browse source
This commit is contained in:
Bill Niblock 2017-05-07 16:59:34 -04:00
parent d0b25e210c
commit 8d2da5c6c6
19 changed files with 1657 additions and 310 deletions
Download patch file Download diff file Expand all files Collapse all files

17
doc/file.README.html
View file

@ -75,7 +75,7 @@ branch represents a choice taken in the dialogue. Branches flow to each other
through leafs, which are the actual choices.</p>
<p>You can experience this yourself, by loading &quot;Example Quest! - A Meta Dialogue
Tree!&quot;. You can find the tree itself at <a href="trees/example_quest.yaml">trees/example_quest.yaml</a>. To run it, just type <code>sapling -t
Tree!&quot;. You can find the tree itself at <a href="var/trees/example_quest.yaml">trees/example_quest.yaml</a>. To run it, just type <code>sapling -t
trees/example_quest.yaml</code>.</p>
<h2>Building a New Tree</h2>
@ -83,16 +83,17 @@ trees/example_quest.yaml</code>.</p>
<p>To build a new tree, you have two options. You can manually edit a configuration
file, or go through the construction wizard. Either way, the end result is a
plain-text configuration file, which can be easily shared, edited, and viewed.
For more details on the configuration file itself, check out the <a href="docs/config_file.md">Configuration
File documentation</a>, or the self-documented <a href="docs/config_file_example.yaml">configuration
file example</a>. Alternatively, you can checkout
<a href="trees/example_quest.yaml">Example Quest</a> for a complete treel</p>
For more details on the configuration file itself, check out the <a href="var/docs/config_file.md">Configuration
File documentation</a>, or the self-documented
<a href="var/docs/config_file_example.yaml">configuration file example</a>. Alternatively,
you can checkout <a href="var/trees/example_quest.yaml">Example Quest</a> for a complete
tree.</p>
<h3>Manual Edit</h3>
<ol>
<li>Open your preferred text editor.</li>
<li>Refer to the <a href="docs/config_file.md">Configuration File documentation</a></li>
<li>Refer to the <a href="var/docs/config_file.md">Configuration File documentation</a></li>
<li>Make your changes.</li>
<li>Save your changes.</li>
</ol>
@ -109,7 +110,7 @@ trunk, and show you the first branch.</li>
<li>Save your changes.</li>
</ol>
<p>More details on the editor can be found in the <a href="docs/editor.md">Editor
<p>More details on the editor can be found in the <a href="var/docs/editor.md">Editor
documentation</a>.</p>
<h2>Contributing</h2>
@ -131,7 +132,7 @@ guidelines</a>.</li>
</div></div>
<div id="footer">
Generated on Sat May 6 18:16:01 2017 by
Generated on Sun May 7 16:58:49 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.2.5).
</div>