aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: e7b8c6ef3fed790fbe2613069625b2b796d6936f (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
# colitur-x

A raw Xlib front-end for [colitur](../colitur): reads `colitur emit --format
csv` on stdin, draws the year as a month grid coloured by each day's
liturgical colour, and shows the selected day's readings underneath.

    colitur emit --format csv --from 2027 --to 2027 | colitur-x

Keys: arrows or `hjkl` move, `n`/`p` change month, `q` quits.

## Why it exists

colitur is a Unix tool: it computes and prints. This is a separate program
that composes with it, so colitur's own dependencies stay frozen
(`dune alcotest qcheck qcheck-alcotest sexplib ppx_sexp_conv`) and its
kernel stays pure.

## Build

    make

`-std=c99 -Os -Wall -Wextra`, linking libX11 and libXft. ~17 KB.

Configuration is compile-time, suckless style: edit `config.h` and rebuild.
There is deliberately no runtime config file — colitur itself owns the
calendar's configuration (language, sigla, overlays); this program owns only
how it is painted.

## Limits, stated rather than discovered

- X11 only. Runs under XWayland but is not a Wayland client.
- Read-only. It renders what colitur emits; it edits nothing.
- Xft is used for antialiasing and UTF-8. Dropping it for core X11 fonts
  would reduce the dependency list to libX11 and libc alone, at the cost of
  correct rendering for `æ`/`œ` and Polish diacritics. Not worth it.
- A tiling window manager will ignore the size hints and give the grid its
  own tile; the layout handles that, the empty space is the WM's choice.