summaryrefslogtreecommitdiffhomepage
path: root/gleam/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'gleam/README.md')
-rw-r--r--gleam/README.md19
1 files changed, 10 insertions, 9 deletions
diff --git a/gleam/README.md b/gleam/README.md
index 8a2bea9..046dc0f 100644
--- a/gleam/README.md
+++ b/gleam/README.md
@@ -27,7 +27,7 @@ model to bytes.
## Build and run
```sh
-nix build --override-input ocda-lib path:../../sisudoc-ocda-lib
+nix build
./result/bin/ocda-write --text <doc>.ssp
./result/bin/ocda-write --text <doc>.ocda.db de
./result/bin/ocda-write --md <doc>.ssp
@@ -35,10 +35,11 @@ nix build --override-input ocda-lib path:../../sisudoc-ocda-lib
./result/bin/ocda-write --typst <doc>.ocda.db en --out out/<doc>.typ
```
-The override applies to `nix develop` too, until the library is published:
+`flake.lock` pins the library at the commit this was checked against. In a
+development shell `gleam` reads it through the `./ocda-lib` symlink (below):
```sh
-nix develop --override-input ocda-lib path:../../sisudoc-ocda-lib -c gleam build
+nix develop -c gleam build
```
## The check
@@ -47,16 +48,16 @@ nix develop --override-input ocda-lib path:../../sisudoc-ocda-lib -c gleam build
./result/bin/ocda-write --text <doc>.ssp | cmp - <the D writer's>
```
-**36 of 36 document-languages, from both serialisations, byte identical to the
+**Every document-language, from both serialisations, byte identical to the
D writer** - which is the check that matters now, since byte identity with
`spine --text` is no longer the target.
And for `--md`, `--html`, `--epub` and `--typst`, **byte identical to the D
-writer on all 36**, which is the agreement that says the model is enough. None
-of them is held to spine's bytes: the epub's judge is epubcheck, which read the
-specification so that the writer need not be trusted to have, and the pdf's is
-typst, where a link to a label that does not exist is a compile error. See the
-repository README for what they do differently and why.
+writer on every document**, which is the agreement that says the model is
+enough. None of them is held to spine's bytes: the epub's judge is epubcheck,
+which read the specification so that the writer need not be trusted to have,
+and the pdf's is typst, where a link to a label that does not exist is a
+compile error. See the repository README for what they do differently and why.
## The library, as a path dependency inside the package