Flesh out README file

This commit is contained in:
David Baer
2015-08-14 22:53:26 -04:00
parent 83fad2f6c4
commit 634767010a

44
README
View File

@@ -1,4 +1,46 @@
sermon 0.9 sermon 0.9
========== ==========
Sermon markup converter This utility converts text markup into various presentable forms.
Usage
-----
sermon [-s STYLE] INPUT
-h Display help message
-s STYLE The stylesheet to use to transform the markup (default: html5)
INPUT Name of markup file (- for stdin)
Markup Syntax
-------------
The markup syntax is very simple:
- Provide a header with title and other information at the top:
[title: My Document Title]
[author: My Name]
[date: January 1, 2015]
[occasion: New Year's Day]
[text: Luke 2:21-40]
Note that all fields are optional.
- Leave a blank line between paragraphs.
- Use *asterisks* for emphasis (rendered in italics)
- Use ^{notename} within the text for a footnote/endnote reference.
Provide the footnote below your text with
{ref:notename:Author, *Title*. etc...}
- For an offset block quotation, prepend > to each line of a paragraph:
> This paragraph will be
> a block quote.
- Text enclosed between [* starred braces *] will be ignored as a comment.