cbr-schedule

An unofficial Bible-reading-plan generator
git clone git://git.danielmoch.com/cbr-schedule.git
Log | Files | Refs | README | LICENSE

README.md (1234B)


      1 # CBR Schedule
      2 
      3 So my church has a Bible reading plan called Community Bible Reading
      4 (CBR).  It had been the practice up until 2018 for them to release the
      5 yearly reading plan as a downloadable PDF file, but as of February 2018
      6 that hasn't happened. I wrote this utility to fill the gap.
      7 
      8 Currently available export formats are:
      9 
     10 1. JSON (machine-readable so you can do what you want with it)
     11 2. Formatted text file
     12 3. Comma-separated values (CSV) (for importing into spreadsheets)
     13 4. LaTeX (for generating PDF files, or other similar formats, assuming
     14    you have access to the LaTeX suite)
     15 
     16 ## Requirements
     17 
     18 1. [Python 3](https://python.org)
     19 2. [The LaTeX suite](http://www.stat.pitt.edu/stoffer/freetex.html) (optional: for creating PDF documents)
     20 
     21 ## Usage
     22 
     23 1. `make text` builds a formatted text file (also built with simply `make`)
     24 2. `make json` builds a JSON file
     25 3. `make csv` builds a CSV file
     26 4. `make latex` build a LaTeX file. From there building a PDF for DVI
     27    file is just a short command away. I would add additional targets to
     28    the Makefile for each of these, but I was getting weird artifacts in
     29    the output files when I build this way.
     30 
     31 ## License
     32 
     33 MIT - See the [LICENSE](/LICENSE) file for more information