summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/typ/building.typ12
-rw-r--r--docs/typ/install.typ2
2 files changed, 8 insertions, 6 deletions
diff --git a/docs/typ/building.typ b/docs/typ/building.typ
index ae2f3a60..8d7524f9 100644
--- a/docs/typ/building.typ
+++ b/docs/typ/building.typ
@@ -9,7 +9,7 @@ pieces fit. To install it, see #doc("setup", section: "install").
= Platforms
-Zig *0.16.0* (`build.zig.zon` pins `minimum_zig_version`). Dependencies are
+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
builds MuPDF and is on by default (`-Dmupdf=false` drops it). 9P over QUIC
@@ -24,10 +24,11 @@ builds MuPDF and is on by default (`-Dmupdf=false` drops it). 9P over QUIC
[`zig build -Dplatform=esp32p4`], [a freestanding riscv32 editor object for the ESP32-P4, with a 384 KiB heap],
)
-A bare `zig build` installs into `~/.local`; `--prefix <dir>` installs
-elsewhere, except `--prefix zig-out`, which counts as no prefix. With
-`-Dplatform` the default prefix is `zig-out`, so always pass `-Dplatform`
-while developing. Test, benchmark and run steps build what they need
+A bare `zig build` installs into the prefix (`zig-out`, or `--prefix
+<dir>`) and copies the binaries into `~/.local/bin`; `-Dhome-install=false`
+leaves that copy out. Zig 0.17 keeps the prefix from the build script, so
+`--prefix` alone no longer stops it. With `-Dplatform` nothing is copied,
+so always pass `-Dplatform` while developing. Test, benchmark and run steps build what they need
without installing. `pardes --version` prints `pardes <version>` (from
`build.zig.zon`), plus the commit for release builds and the `~/.local`
install; `pardes --help` lists every flag.
@@ -50,6 +51,7 @@ there; its namespace is in `src/esp32p4_gpio.zig`.
[`-Djpx`], [bool, `true`: JPEG 2000, and with it scanned PDFs],
[`-Dtree-sitter`], [`disabled`, `zig`, `minimal`, `full`; `full` natively, `zig` for web, `disabled` for esp32p4],
[`-Dembed-sources`], [bool, `false`: serve the sources under #file("/src")],
+ [`-Dhome-install`], [bool: a bare `zig build` also copies the binaries into `~/.local/bin`; default true],
[`-Dstamp-commit`], [bool: the git commit in `--version` and crash records; on for release builds and the `~/.local` install],
[`-Dtheme-animation`], [bool; on except for esp32p4],
[`-Dworkspace-tag`], [bool: draw the workspace tag row; on except for macOS, whose menu bar carries it],
diff --git a/docs/typ/install.typ b/docs/typ/install.typ
index 9758777d..d97d30f7 100644
--- a/docs/typ/install.typ
+++ b/docs/typ/install.typ
@@ -18,7 +18,7 @@
#let first = project.mirrors.first()
#cmd("git clone " + first.clone + " && cd pardes")
-With Zig 0.16 (the build fetches everything else; once that is
+With Zig 0.17 (the build fetches everything else; once that is
downloaded, a first build from a clean cache took 62 seconds on 16 cores):
#cmd("# pardes, in a terminal\nzig build -Dplatform=tty --prefix ~/.local")
#cmd("# pardes-gui, its own window\nzig build -Dplatform=gui --prefix ~/.local")