diff options
| author | Lukasz Kasprzak <lukas@labunix.xyz> | 2026-07-29 10:06:24 +0200 |
|---|---|---|
| committer | Lukasz Kasprzak <lukas@labunix.xyz> | 2026-07-29 10:06:24 +0200 |
| commit | d17262c10fc24557741a5b571f40dfd9625fdb2e (patch) | |
| tree | 7f2aa12a0cbdb1b599a9802872cab6f1b7657c81 /README.md | |
| parent | 389a038f55731d3df82cae71a0bec4db7086059c (diff) | |
| download | clectio-d17262c10fc24557741a5b571f40dfd9625fdb2e.tar.gz clectio-d17262c10fc24557741a5b571f40dfd9625fdb2e.zip | |
feat: man page (clectio.1), installed by make install
Add a manual page covering usage, the -a/-g and --month options, the compile-
time config.h settings (FORM/SIGLA/COLOR/GOSPEL_ONLY/WRAP), and both the
bring-your-own-Bible and bring-your-own-calendar workflows, matching the README.
Install it via make (MANPREFIX = $PREFIX/share/man); uninstall removes it too.
Renders clean under man --warnings.
Claude-Session: https://claude.ai/code/session_01S1CD1u3tgSS4xNu6WHfp5a
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 3 |
1 files changed, 2 insertions, 1 deletions
@@ -20,7 +20,7 @@ the Go engine that computes and generates clectio's data. ./clectio -a # all readings (override a Gospel-only build) ./clectio --month # this month at a glance (day, colour, celebration) ./clectio --month 2026-04 > apr.txt # a month to a file for reference - make install # into $PREFIX/bin (default /usr/local) + make install # binary into $PREFIX/bin, man page into $PREFIX/share/man Needs only a C99 compiler and libc. It builds in about a second. @@ -184,6 +184,7 @@ guessed. To extend the range, regenerate `gen/` with lectio's `clectio-gen` puff.c/.h DEFLATE decompressor (Mark Adler's puff, public domain) mktext.c build tool: resolve verse keys against a corpus, gzip-pack the text bin2h.c build tool: embed the packed text as C + clectio.1 the manual page (installed by make install) gen/ generated, corpus-independent data (calendar + citations) text_of.lz the default Vulgate text, DEFLATE-packed (one per form) |