diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..e5a6c5f --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# colitur + +*computus liturgicus* — a safe, highly-tested, deterministic engine that computes +and validates liturgical calendars for multiple rites, with template-driven output. + +Starting with the Roman EF (1962) and OF forms; extensible to other traditions. +Computes day-identity (season, celebration, rank, colour, cycle, precedence) and +reading citations, correct to year 9999. See the design and rules research under +`docs/` (local). + +## Build + +```sh +opam switch create . 5.2.0 -y # first time: local OCaml switch +opam install -y dune alcotest qcheck qcheck-alcotest +dune build +dune test +dune exec colitur -- easter 2026 +``` + +## License + +AGPL-3.0-or-later. See `LICENSE`. |