aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Moch2018-02-24 22:39:31 -0500
committerDaniel Moch2018-02-24 22:39:31 -0500
commit19d648d7c82f0bcce8a160158095e61caaa07b1a (patch)
tree32696ed64ddf91166d6bcb0e313b20ea0d24d174
parentc43fb61ee66c81b6cf28ea89cbcaa1235c6fe24a (diff)
parentffeaa687912615d28fa0ca53cfbc74bba22e65e3 (diff)
downloadcbr-schedule-19d648d7c82f0bcce8a160158095e61caaa07b1a.tar.gz
Merge branch 'master' into v0.1.0
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..393fe1f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# 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.
+
+Currently available export formats are:
+
+1. JSON (machine-readable so you can do what you want with it)
+2. Formatted text file
+
+Other export formats on the roadmap:
+
+1. LaTeX (for generating PDF files, or other similar formats, assuming
+ you have access to the LaTeX suite)
+2. CSV (for importing into spreadsheets)
+
+# Usage
+
+A Makefile would be nice, I'll get one of those up soon too. In the
+meantime, the process will be a bit manual. Take the following example:
+
+```
+./generate_readings sections/old_testament.in
+./generate_readings sections/new_testament.in
+./generate_readings sections/psalms.in
+./generate_schedule output.txt
+```
+
+The final result of these commands would be a file called `output.txt`
+that contains
+
+# License
+
+MIT - See the [LICENSE](/LICENSE) file for more information