about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorCase Duckworth2015-03-02 16:59:55 -0700
committerCase Duckworth2015-03-02 16:59:55 -0700
commit26e1a84cbbf50330ce36724e6511edf40dea9548 (patch)
tree536904cc97a4a9cecfcf7c0863e85286f704efd0
parentAdd TODO.txt (diff)
downloadautocento-26e1a84cbbf50330ce36724e6511edf40dea9548.tar.gz
autocento-26e1a84cbbf50330ce36724e6511edf40dea9548.zip
Update README
-rw-r--r--README.md68
1 files changed, 35 insertions, 33 deletions
diff --git a/README.md b/README.md index 91e57b3..0221591 100644 --- a/README.md +++ b/README.md
@@ -1,47 +1,49 @@
1# Autocento of the breakfast table 1Autocento of the breakfast table: a README
2## User guide and manual 2================================
3## or whatever. I don't care.
4 3
5# Part I: in which our hero explains the goal 4Part I: in which our hero explains the goal
5-------------------------------------------
6 6
7The goal in this book, *Autocento of the breakfast table*, is to explore the 7The 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.
8workings of revision and recursion through words, both in the head and on 8It's a hypertextual imagining of how things could have been, in all of their possibilities.
9paper. It's a hypertextual imagining of how things could have been, in all
10of their possibilities.
11 9
12# Part II: Enough of that high-faluting bullshit; down to brass tax 10Part II: How to use this repo
13## A.K.A. Using Pandoc to compile them pages, neff 11-----------------------------
14 12
15This project uses John MacFarlane's amazing, etc. [pandoc][] for the fun, 13This project uses John McFarlane's wonderful program [pandoc][], and its markdown flavor, to encode the poems and stories and things contained within.
16HTML-writing stuff. Use the `compile.sh` script to compile the stuff down. 14To see the source text files, navigate to the [src/](autocento.me/src/) folder.
17 15
18*Note: you're on Windows right now, so make sure and type `bash compile.sh` to 16At the top of each file, there is a YAML metadata block that looks something like this:
19run the program.*
20
21At the top of each file, there should be a YAML block that looks something
22like this:
23 17
24````yaml 18````yaml
25--- 19---
26title: 'Title of poem' 20title: Title of poem
27subtitle: 'Subtitle' # optional 21subtitle: Subtitle # optional
28genre: '[verse|prose]' 22genre: verse # verse or prose
23
24epigraph: # optional
25- content: 'Quote from outside' # req'd if epigraph exists
26 link: 'Link to online version of epigraph' # optional
27 attrib: 'Who said the epigraph' # optional
28
29dedication: John Doe # optional
29 30
30project: 31project:
31- title: 'Original project name' 32 title: Original project name
32 order: [number] 33 order: 1 # original project order
33 prev: 34 prev:
34 - title: 'Title of previous thing in original project' 35 - title: Title of previous thing in original project
35 link: 'link to that thing' 36 link: link to that thing
36 next: 37 - title: Title of other previous thing
37 - title: 'Title of next thing in original project' 38 link: link to that thing
38 - link: 'link to that thing' 39 next:
39 40 - title: Title of next thing in original project
40epigraph: # optional 41 link: link to that thing
41- content: 'Quote from outside' 42 - title: Title of other next thing
42 link: 'Link to online version of epigraph' 43 link: link to that thing
43 attrib: 'Who said the epigraph' # optional
44... 44...
45```` 45````
46 46
47To compile all the markdown into glorious, glorious HTML (visible at <autocento.me>), run `compile.sh` (`bash compile.sh` in Windows) in the root directory of this git repository.
48
47[pandoc]: http://johnmacfarlane.net/pandoc/ 49[pandoc]: http://johnmacfarlane.net/pandoc/