aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5d51e44..924c700 100644
--- a/README.md
+++ b/README.md
@@ -297,6 +297,27 @@ data — no external service:
Switch per run with `--lectionary new|traditional`, or set `lectionary`
in config for a permanent default.
+## Calendar of saints
+
+The universal sanctorale (saints, ranks, colours, names) is embedded and
+oracle-validated, so it works out of the box. Because the Church changes it over
+time, it can be updated or customised without a rebuild, in two tiers — both plain
+INI:
+
+- **Local additions overlay on top.** Drop `~/.config/lectio/calendars/<name>.ini`
+ and enable it with `use = <name>` (comma list, later wins). A layer **adds** a
+ saint, **overrides** any field of an existing one (rank, colour, name, readings),
+ or **suppresses** it (`suppress = true`). This is the place for diocesan/national
+ propers and one-off rank fixes — you only write the deltas.
+- **Replace the whole base.** Drop `~/.config/lectio/sanctorale/of.ini` (Ordinary
+ Form) or `ef.ini` (Extraordinary Form) and it is used *instead of* the embedded
+ calendar — for shipping a full refreshed calendar (regenerate with
+ `scripts/gen-sanctoral.go`). A missing or malformed file falls back to the
+ embedded default, so the tool stays self-contained and correct.
+
+The temporal cycle and the precedence rules (Table of Liturgical Days) are
+computed in code — only the sanctorale is data.
+
## Scripture corpora
Only the Latin **Vulgate** (`vul`) — public domain, lectio's own hand-curation —