diff options
| author | Case Duckworth | 2015-01-29 22:54:41 -0700 |
|---|---|---|
| committer | Case Duckworth | 2015-01-29 22:54:41 -0700 |
| commit | 7f93c5f7205bc1cc0c2e21694fd10880eec51aca (patch) | |
| tree | f68587ec92369e619961087bab01cbd387bbb06e /README.html | |
| parent | Update index to link to Github, README YAML spec (diff) | |
| download | autocento-7f93c5f7205bc1cc0c2e21694fd10880eec51aca.tar.gz autocento-7f93c5f7205bc1cc0c2e21694fd10880eec51aca.zip | |
Add Hezekiah; Work out YAML metainfo"
Diffstat (limited to 'README.html')
| -rw-r--r-- | README.html | 23 |
1 files changed, 18 insertions, 5 deletions
| diff --git a/README.html b/README.html index 4c6eaac..97616a4 100644 --- a/README.html +++ b/README.html | |||
| @@ -9,9 +9,22 @@ | |||
| 9 | <p><em>Note: you're on Windows right now, so make sure and type <code>bash compile.sh</code> to run the program.</em></p> | 9 | <p><em>Note: you're on Windows right now, so make sure and type <code>bash compile.sh</code> to run the program.</em></p> |
| 10 | <p>At the top of each file, there should be a YAML block that looks something like this:</p> | 10 | <p>At the top of each file, there should be a YAML block that looks something like this:</p> |
| 11 | <pre class="sourceCode yaml"><code class="sourceCode yaml"><span class="ot">---</span> | 11 | <pre class="sourceCode yaml"><code class="sourceCode yaml"><span class="ot">---</span> |
| 12 | <span class="fu">title:</span> <span class="st">'Title of poem or whatever'</span> | 12 | <span class="fu">title:</span> <span class="st">'Title of poem'</span> |
| 13 | <span class="fu">subtitle:</span> <span class="st">'Subtitle, if it exists'</span> | 13 | <span class="fu">subtitle:</span> <span class="st">'Subtitle'</span><span class="er"> # optional</span> |
| 14 | <span class="fu">epigraph:</span> <span class="st">'Include epigraph here, if it exists'</span> | 14 | <span class="fu">genre:</span> <span class="st">'[verse|prose]'</span> |
| 15 | <span class="fu">epigraph-credit:</span> <span class="st">'Who said the epigraph or wrote it or whatever'</span> | 15 | |
| 16 | <span class="fu">project:</span> <span class="st">'Original project here'</span> | 16 | <span class="fu">project:</span> |
| 17 | <span class="kw">-</span> <span class="fu">title:</span> <span class="st">'Original project name'</span> | ||
| 18 | <span class="fu">order:</span> <span class="kw">[</span>number<span class="kw">]</span> | ||
| 19 | <span class="fu">prev:</span> | ||
| 20 | <span class="kw">-</span> <span class="fu">title:</span> <span class="st">'Title of previous thing in original project'</span> | ||
| 21 | <span class="fu">link:</span> <span class="st">'link to that thing'</span> | ||
| 22 | <span class="fu">next:</span> | ||
| 23 | <span class="kw">-</span> <span class="fu">title:</span> <span class="st">'Title of next thing in original project'</span> | ||
| 24 | <span class="kw">-</span> <span class="fu">link:</span> <span class="st">'link to that thing'</span> | ||
| 25 | |||
| 26 | <span class="fu">epigraph:</span> <span class="co"># optional</span> | ||
| 27 | <span class="kw">-</span> <span class="fu">content:</span> <span class="st">'Quote from outside'</span> | ||
| 28 | <span class="fu">link:</span> <span class="st">'Link to online version of epigraph'</span> | ||
| 29 | <span class="fu">attrib:</span> <span class="st">'Who said the epigraph'</span><span class="er"> # optional</span> | ||
| 17 | <span class="co">...</span></code></pre> | 30 | <span class="co">...</span></code></pre> |