aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLukasz Kasprzak <lukas@labunix.xyz>2026-08-26 13:57:20 +0200
committerLukasz Kasprzak <lukas@labunix.xyz>2026-08-26 13:57:20 +0200
commite5066c0d082a09eca3d4c8bbf8da1cc04dde9104 (patch)
treef696822ad327a1c65fe20f0e0fb2c8918afaae8b
parent03d3c00ccdde318207c8b4fdc456e5e64d6b4abf (diff)
downloadcolitur-e5066c0d082a09eca3d4c8bbf8da1cc04dde9104.tar.gz
colitur-e5066c0d082a09eca3d4c8bbf8da1cc04dde9104.zip
docs(readme): describe the OF module, fix the stale test count
README.md said "lib/rites/ contains rite_ef and nothing else" and "treat any claim of multi-rite support as a design goal rather than a feature" -- false as of this branch: lib/rites/ also contains rite_of, wired into a working --rite of. Rewrite the opening paragraph to state what actually ships, with the OF's own honest limits relative to the EF's (no published-ordo witness, Polish-vernacular lectionary lineage, known-wrong pinned dates, First reading + Gospel only). Also fixes two further stale numbers this same paragraph's neighbours carried, unrelated to this branch's own content but caught while here: "dune test # fast suite, 568 tests" (actual: 887) and "## Status"'s "v0.9.0, EF only. 569 tests" (actual tag: v1.0.0; this line is written from an unreleased branch, stated as such rather than inventing a version number).
-rw-r--r--README.md35
1 files changed, 25 insertions, 10 deletions
diff --git a/README.md b/README.md
index 5f4724f..32cd61a 100644
--- a/README.md
+++ b/README.md
@@ -12,11 +12,20 @@ and validates liturgical calendars, with template-driven output.
Computes day-identity (season, celebration, rank, colour, precedence) and reading
citations, correct to year 9999.
-**What is built today is the Roman EF (1962) — that rite alone.** `lib/rites/`
-contains `rite_ef` and nothing else. The kernel is rite-agnostic and the OF is
-the next module, which is what will prove the abstraction generalises; until
-then, treat any claim of multi-rite support as a design goal rather than a
-feature. See the design and rules research under `docs/` (local).
+**Two rites are built: the Roman EF (1962) and the Roman OF (post-1970,
+base calendar the 2002 *Missale Romanum*).** `lib/rites/` contains
+`rite_ef` and `rite_of`, both plugging into the same rite-agnostic kernel
+via `Rite.t` — the abstraction the OF module exists to prove generalises.
+Select the rite with `--rite ef|of` on `day`/`readings` (default `ef`); see
+`colitur.1`'s own `--rite` entry. The EF is the more thoroughly validated
+of the two, checked against five independent layers including a published
+Ordo witness; the OF is younger — no published-ordo witness yet, a
+Polish-vernacular lectionary lineage (not the Latin OLM itself), a handful
+of known-wrong days pinned rather than fixed (St Joseph anticipated onto
+Palm Sunday, Normae n. 56(f); the Holy Family Sunday fallback of Normae
+n. 35(a)), and its lectionary carries only the first reading and the
+Gospel, not the Second Reading or the responsorial psalm. See the design
+and rules research under `docs/` (local).
## Build
@@ -24,11 +33,12 @@ feature. See the design and rules research under `docs/` (local).
opam switch create . 5.2.0 -y # first time: local OCaml switch
opam install -y dune alcotest qcheck qcheck-alcotest sexplib ppx_sexp_conv
dune build
-dune test # fast suite, 568 tests (~8s)
+dune test # fast suite, 887 tests (~8s)
COLITUR_EXHAUSTIVE_SWEEP=1 dune test --force # + every year 1583-9999 (~80s)
dune exec colitur -- easter 2026 # Easter and its Easter-relative anchors
dune exec colitur -- temporal 2026 # the EF temporal cycle only, one line per day
dune exec colitur -- day 2026 # the full resolved EF calendar (temporal + sanctoral)
+dune exec colitur -- day --rite of 2026 # the same, for the OF
```
## Rendering
@@ -141,11 +151,16 @@ sections, `lang/traditions.ini` in full, and all three `--sigla-*` flags.
## Status
-v0.9.0, EF only. **569 tests**, of which the property suite runs against every
-year in 1583-9999 rather than a sample — that is how confidence extends past
-the ~2050 horizon of any reference to check against.
+Tagged releases (`v1.0.0` and earlier) are EF only; this line is being
+written from an unreleased branch that adds the OF module (see above).
+**887 tests**, of which the property suite runs against every year in
+1583-9999 rather than a sample — that is how confidence extends past the
+~2050 horizon of any reference to check against. The six layers below
+describe the EF's own validation specifically; the OF's own (also
+property, differential — against `litcal`, an independent second lineage
+— and golden) is younger and lighter, with no published-ordo witness yet.
-Six validation layers, each blind to something the others catch:
+Six validation layers, each blind to something the others catch (EF):
| | |
|---|---|