aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6252224..f892611 100644
--- a/README.md
+++ b/README.md
@@ -59,6 +59,19 @@ zig build test # run unit tests
EPUBs land in `epubs/zig-<version>.epub`.
+### Validating output
+
+The tool guarantees well-formed XHTML, but full EPUB3 conformance (the kind of
+thing Kindle's "Send to Kindle" enforces) is checked with
+[epubcheck](https://github.com/w3c/epubcheck), the official validator:
+
+```sh
+brew install epubcheck # one-time (needs a JRE)
+./validate.sh # runs epubcheck on every epub; non-zero exit on errors
+```
+
+`validate.sh` fails loudly if any EPUB has errors, so it doubles as a CI gate.
+
## Continuous integration
`.forgejo/workflows/build-epubs.yml` runs on [Codeberg](https://codeberg.org)