aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLukasz Kasprzak <lukasz@arcofasiagroup.com>2026-08-21 09:38:22 +0200
committerLukasz Kasprzak <lukasz@arcofasiagroup.com>2026-08-21 09:38:22 +0200
commitd58ac7945a97b4029772022550775ab834c81b97 (patch)
tree37c170b31593991fd6f0a15387be36aefae908f9 /README.md
parentc453d5c3ba41af61975a83ea553b41e410d88ae2 (diff)
downloadcolitur-x-d58ac7945a97b4029772022550775ab834c81b97.tar.gz
colitur-x-d58ac7945a97b4029772022550775ab834c81b97.zip
build: proper Makefile with install, and usage in the README
PREFIX ?= $(HOME)/.local and a '## '-comment help target, matching the sibling projects. The old file had no all target, no install, and a clean that removed only one of the two binaries.
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index a5662fc..920c056 100644
--- a/README.md
+++ b/README.md
@@ -4,10 +4,25 @@ A raw Xlib front-end for [colitur](../colitur): reads `colitur emit --format
csv` on stdin, draws the year as a month grid coloured by each day's
liturgical colour, and shows the selected day's readings underneath.
+ make && make install # into ~/.local/bin
colitur emit --format csv --from 2027 --to 2027 | colitur-x
Keys: arrows or `hjkl` move, `n`/`p` change month, `q` quits.
+It reads CSV on **stdin** and nothing else, so the shell decides what it
+shows. One month:
+
+ colitur emit --format csv --from 2027 --to 2027 \
+ | { head -1; grep "^2027-04"; } | colitur-x
+
+Another language, or a local calendar:
+
+ colitur emit --format csv --from 2027 --to 2027 --lang en | colitur-x
+ colitur emit --format csv --from 2027 --to 2027 \
+ --overlay ~/parish.sexp | colitur-x
+
+With no input it says so and exits 2.
+
## Why it exists
colitur is a Unix tool: it computes and prints. This is a separate program