aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLukasz Kasprzak <lukas@labunix.xyz>2026-07-30 13:01:01 +0200
committerLukasz Kasprzak <lukas@labunix.xyz>2026-07-30 13:01:01 +0200
commit1ac11af6c1a2d34362932331d60f441faf882623 (patch)
tree407ad29745ad687d5673af8a1e75a562115371e0
parentba1b441e1da4e99546b3b7e755c8d31b73055343 (diff)
downloadclectio-1ac11af6c1a2d34362932331d60f441faf882623.tar.gz
clectio-1ac11af6c1a2d34362932331d60f441faf882623.zip
docs: name exact corpus paths + note the form follows config.h
Bring-your-own-Bible: state that vul lives in internal/bible/corpora/ and wuj/drb/grb under corpora_optional/, show both the drb and wuj build commands, and note the build repacks text_of.lz (OF) or text_ef.lz (FORM_EF in config.h) accordingly.
-rw-r--r--README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/README.md b/README.md
index c5308c9..97fe82e 100644
--- a/README.md
+++ b/README.md
@@ -52,11 +52,17 @@ well under 1 MiB with any text. To build with a different translation, point
make CC=gcc CORPUS=/path/to/mybible.tsv
-You already have four corpora in the required format: lectio ships them under
-`internal/bible/` — Vulgate (`vul`), Douay-Rheims (`drb`), Wujek (`wuj`) and
-Greek (`grb`). For an English build:
+You already have four corpora in the required format under lectio's
+`internal/bible/`: the Vulgate (`vul`) lives in `corpora/`; Douay-Rheims (`drb`),
+Wujek (`wuj`) and Greek (`grb`) are opt-in under `corpora_optional/`. So an
+English (Douay-Rheims) or Polish (Wujek) build is just:
make CC=gcc CORPUS=~/git/projects/lectio/internal/bible/corpora_optional/drb.tsv
+ make CC=gcc CORPUS=~/git/projects/lectio/internal/bible/corpora_optional/wuj.tsv
+
+The build repacks the text blob for whichever form `config.h` selects: the
+default (Ordinary Form) writes `text_of.lz`; add `#define FORM_EF` to `config.h`
+first for an Extraordinary Form build, which writes `text_ef.lz` instead.
### Corpus format