From 2ef9e0264675677278d54a9a30b1aacecb5e42f0 Mon Sep 17 00:00:00 2001 From: Case Duckworth Date: Wed, 28 Jan 2015 22:30:22 -0700 Subject: Add to the Readme --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) 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 workings of revision and recursion through words, both in the head and on paper. It's a hypertextual imagining of how things could have been, in all of their possibilities. + +# Part II: Enough of that high-faluting bullshit; down to brass tax +## A.K.A. Using Pandoc to compile them pages, neff + +This project uses John MacFarlane's amazing, etc. [pandoc][] for the fun, +HTML-writing stuff. Use the `compile.sh` script to compile the stuff down. + +*Note: you're on Windows right now, so make sure and type `bash compile.sh` to +run the program.* + +At the top of each file, there should be a YAML block that looks something +like this: + +````yaml +--- +title: 'Title of poem or whatever' +subtitle: 'Subtitle, if it exists' +epigraph: 'Include epigraph here, if it exists' +epigraph-credit: 'Who said the epigraph or wrote it or whatever' +project: 'Original project here' +... +```` + +[pandoc]: http://johnmacfarlane.net/pandoc/ -- cgit 1.4.1-21-gabe81