diff options
author | Case Duckworth | 2015-01-28 22:30:22 -0700 |
---|---|---|
committer | Case Duckworth | 2015-01-28 22:30:22 -0700 |
commit | 2ef9e0264675677278d54a9a30b1aacecb5e42f0 (patch) | |
tree | d9b509c1a1187be403ad947adb0a56d6d403421d | |
parent | Add Elegies; template; pandoc compile script (diff) | |
download | autocento-2ef9e0264675677278d54a9a30b1aacecb5e42f0.tar.gz autocento-2ef9e0264675677278d54a9a30b1aacecb5e42f0.zip |
Add to the Readme
-rw-r--r-- | README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md index 07f37cb..bb42779 100644 --- a/README.md +++ b/README.md | |||
@@ -8,3 +8,27 @@ The goal in this book, *Autocento of the breakfast table*, is to explore the | |||
8 | workings of revision and recursion through words, both in the head and on | 8 | workings of revision and recursion through words, both in the head and on |
9 | paper. It's a hypertextual imagining of how things could have been, in all | 9 | paper. It's a hypertextual imagining of how things could have been, in all |
10 | of their possibilities. | 10 | of their possibilities. |
11 | |||
12 | # Part II: Enough of that high-faluting bullshit; down to brass tax | ||
13 | ## A.K.A. Using Pandoc to compile them pages, neff | ||
14 | |||
15 | This project uses John MacFarlane's amazing, etc. [pandoc][] for the fun, | ||
16 | HTML-writing stuff. Use the `compile.sh` script to compile the stuff down. | ||
17 | |||
18 | *Note: you're on Windows right now, so make sure and type `bash compile.sh` to | ||
19 | run the program.* | ||
20 | |||
21 | At the top of each file, there should be a YAML block that looks something | ||
22 | like this: | ||
23 | |||
24 | ````yaml | ||
25 | --- | ||
26 | title: 'Title of poem or whatever' | ||
27 | subtitle: 'Subtitle, if it exists' | ||
28 | epigraph: 'Include epigraph here, if it exists' | ||
29 | epigraph-credit: 'Who said the epigraph or wrote it or whatever' | ||
30 | project: 'Original project here' | ||
31 | ... | ||
32 | ```` | ||
33 | |||
34 | [pandoc]: http://johnmacfarlane.net/pandoc/ | ||