summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/README.md b/README.md
index 2fea861..eb763e2 100644
--- a/README.md
+++ b/README.md
@@ -18,14 +18,18 @@ the Go engine that computes and generates clectio's data.
./clectio 2026-12-25 # a given date
./clectio -g 2026-12-25 # the Gospel only
./clectio -a # all readings (override a Gospel-only build)
+ ./clectio --month # this month at a glance (day, colour, celebration)
+ ./clectio --month 2026-04 > apr.txt # a month to a file for reference
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.
+The run-time options are `-a`/`--all`, `-g`/`--gospel` (which reading set to
+print, overriding the compiled default), `--month [YYYY-MM | N]` (one line per
+day of a month — weekday, colour and celebration, no readings; defaults to the
+current month) 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)