aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: e5a6c5f360c701e3b9259b4ebced2f7470f8b447 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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`.