summaryrefslogtreecommitdiff
path: root/docs/typ/building.typ
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-11-06 13:21:54 -0300
committerGabriel Schneider <[email protected]>2026-11-06 14:24:59 -0300
commitb7fdfb18ffd199d49a254c1c799bc3415ad45ec2 (patch)
tree9e52b7a09c2e939f6efd4765c3e8d97464437a21 /docs/typ/building.typ
parentc37a700474e8b84cc3c7db8bf550b7c5f18b1871 (diff)
downloadpardes-b7fdfb18ffd199d49a254c1c799bc3415ad45ec2.tar.gz
pardes-b7fdfb18ffd199d49a254c1c799bc3415ad45ec2.zip
kinds #24, the addons as build steps: `zig build image` and `zig build pdf` each build their library and install it in <prefix>/lib/pardes/addons (and ~/.local/lib/pardes/addons with the home install), `zig build addons` both, the default install the binaries alone and -Dmupdf gone, MuPDF compiled only for the pdf step and the tests that depend on its artifact as before (fetched at the first configure, which Zig runs alike for every step); install.typ, building.typ, reference.typ, shared-libs.md, the README and the changelog say so
Co-Authored-By: Claude Fable 5.1 <[email protected]> Claude-Session: https://claude.ai/code/session_016Y9MNAtZenFv4weoMD3cge
Diffstat (limited to 'docs/typ/building.typ')
-rw-r--r--docs/typ/building.typ10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/typ/building.typ b/docs/typ/building.typ
index 50b85986..311d98c0 100644
--- a/docs/typ/building.typ
+++ b/docs/typ/building.typ
@@ -11,10 +11,11 @@ pieces fit. To install it, see #doc("setup", section: "install").
Zig *0.17.0* (`build.zig.zon` pins `minimum_zig_version`). Dependencies are
fetched and pinned by the manifest; the terminal build needs no system
-package. The SDL shell builds SDL3 and FreeType from source. PDF support
-is an addon, `pdf.so`, built over MuPDF (its own FreeType and zlib in it)
-and on by default (`-Dmupdf=false` leaves it out); the binaries hold no
-MuPDF.
+package. The SDL shell builds SDL3 and FreeType from source. Pictures and
+PDFs are addons, each its own step: `zig build image`, `zig build pdf`
+(`pdf.so`, over MuPDF, its own FreeType and zlib in it), or `zig build
+addons` for both; the binaries hold neither, and MuPDF is compiled only
+for the `pdf` step and the tests.
#pairs(
[`zig build`], [the terminal shell and the SDL window together, *installed into `~/.local/bin`* (`pardes` and `pardes-gui`)],
@@ -40,7 +41,6 @@ must share with its session; `pardes --help` lists every flag.
#pairs(
[`-Dplatform`], [`tui`, `gui`, `macos`; absent: the tui and SDL shells together, installed into `~/.local`],
[`-Dstatic`], [bool, `false`],
- [`-Dmupdf`], [bool, `true`: build and install the PDF addon],
[`-Djpx`], [bool, `true`: JPEG 2000, and with it scanned PDFs],
[`-Dtree-sitter`], [`disabled`, `zig`, `minimal`, `full`; `full`],
[`-Dembed-sources`], [bool, `false`: serve the sources under #file("/src")],