cbr-schedule

commit 4e02e4fffc511f03f512601f4c217991a386a1e7
parent 19d648d7c82f0bcce8a160158095e61caaa07b1a
Author: Daniel Moch <daniel@danielmoch.com>
Date:   Sat, 24 Feb 2018 22:45:42 -0500

Update README.md. Add requirements. Clarify Usage.

Diffstat:
M
README.md
 | 
15
++++++++++-----

1 file changed, 10 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 # CBR Schedule
 
-So my church has a Bible reading plan called Community Bible Reading.
-It had been the practice up until 2018 for them to release the yearly
-reading plan as a downloadable PDF file, but as of February 2018 that
-hasn't happened. I wrote this utility to fill the gap.
+So my church has a Bible reading plan called Community Bible Reading
+(CBR).  It had been the practice up until 2018 for them to release the
+yearly reading plan as a downloadable PDF file, but as of February 2018
+that hasn't happened. I wrote this utility to fill the gap.
 
 Currently available export formats are:
 
@@ -16,6 +16,11 @@ Other export formats on the roadmap:
    you have access to the LaTeX suite)
 2. CSV (for importing into spreadsheets)
 
+# Requirements
+
+1. Python 3
+2. The LaTeX suite (optional: for creating PDF documents)
+
 # Usage
 
 A Makefile would be nice, I'll get one of those up soon too. In the
@@ -29,7 +34,7 @@ meantime, the process will be a bit manual. Take the following example:
 ```
 
 The final result of these commands would be a file called `output.txt`
-that contains
+that contains a formatted text file with the 2018 CBR schedule.
 
 # License