aboutsummaryrefslogtreecommitdiff
path: root/bin/main.ml
diff options
context:
space:
mode:
Diffstat (limited to 'bin/main.ml')
-rw-r--r--bin/main.ml18
1 files changed, 18 insertions, 0 deletions
diff --git a/bin/main.ml b/bin/main.ml
index a6af8df..93ce023 100644
--- a/bin/main.ml
+++ b/bin/main.ml
@@ -420,6 +420,24 @@ overlays:
supply. A directive naming a slug that does not exist warns on
stderr and the run continues; a file that fails to load is fatal.
+ To write one:
+
+ colitur new-overlay > my-parish.sexp # a commented starter
+ $EDITOR my-parish.sexp
+ colitur check my-parish.sexp # parses? every directive hit?
+ colitur day 2026 --overlay my-parish.sexp
+
+ `check` reports what each directive targets and exits 2 if a file
+ will not load or a directive matched nothing, so it fits a
+ Makefile or a pre-commit hook. It does not check a calendar
+ against the rubrics -- nothing here can.
+
+ In an added celebration, `citations` and `layer` may be omitted:
+ they default to empty and to the overlay's own id. Dates may be
+ (Fixed (month M) (day D)), (Easter_offset N) signed, or
+ (Nth_weekday (month M) (nth N) (weekday W)) with N negative to
+ count from the end of the month.
+
environment:
COLITUR_DATA_DIR
Read the calendar data from this directory instead of the