diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
1 files changed, 9 insertions, 1 deletions
@@ -16,10 +16,17 @@ the Go engine that computes and generates clectio's data. make # Ordinary Form, English sigla, Latin Vulgate ./clectio # today ./clectio 2026-12-25 # a given date + ./clectio -g 2026-12-25 # the Gospel only + ./clectio -a # all readings (override a Gospel-only build) make install # into $PREFIX/bin (default /usr/local) Needs only a C99 compiler and libc. It builds in about a second. +The only run-time options are `-a`/`--all`, `-g`/`--gospel` (which reading set +to print, overriding the compiled default) and `-h`/`--help`; everything else is +compile-time. Reading text wraps to the terminal width by default (see `WRAP`); +piped output is left one line per verse. + ## Configure (suckless style) Edit `config.h` (copied from `config.def.h` on first build), then `make`: @@ -27,7 +34,8 @@ Edit `config.h` (copied from `config.def.h` on first build), then `make`: * `FORM_OF` / `FORM_EF` — Ordinary Form (1969) or Extraordinary Form (1962) * `SIGLA_ENGLISH` / `SIGLA_LATIN` — citation dialect (`Jer 14` vs `Ier 14`) * `COLOR` — colour the day name with its liturgical colour - * `GOSPEL_ONLY` — print every reading (0, default) or just the Gospel (1) + * `GOSPEL_ONLY` — default reading set: every reading (0) or the Gospel only (1); override per run with `-a` / `-g` + * `WRAP` — wrap reading text at N columns; `0` fits the terminal (and leaves piped output unwrapped) One form per binary; for both, build twice. The interface is English only. |