summaryrefslogtreecommitdiff
path: root/README.md
blob: aafde4ecb0873207b113ee651d0d3ee59d9fefa1 (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
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# 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 sexplib ppx_sexp_conv
dune build
dune test                           # fast suite (~3s)
COLITUR_EXHAUSTIVE_SWEEP=1 dune test --force   # + every year 1583-9999 (~50s)
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)
```

## Rendering

```sh
dune exec colitur -- table --year 2027 --template templates/ef/ordo.tex > ordo.tex && pdflatex ordo.tex
dune exec colitur -- table --year 2027 --template templates/ef/grid.tex > grid.tex && pdflatex grid.tex
dune exec colitur -- publish --from 2027 --to 2027 --out ./public
```

See `colitur-templates(5)` for the template format (syntax, escaping, the
full field reference) and `colitur(1)` for `emit`, `table`/`render` and
`publish` in full.

## License

AGPL-3.0-or-later. See `LICENSE`.