diff options
Diffstat (limited to 'docs/typ/building.typ')
| -rw-r--r-- | docs/typ/building.typ | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/typ/building.typ b/docs/typ/building.typ index c6ca4e36..24229f08 100644 --- a/docs/typ/building.typ +++ b/docs/typ/building.typ @@ -17,7 +17,7 @@ builds MuPDF and is on by default (`-Dmupdf=false` drops it). 9P over QUIC #pairs( [`zig build`], [the terminal shell and the SDL window together, *installed into `~/.local/bin`* (`pardes` and `pardes-gui`)], - [`zig build -Dplatform=tty`], [the terminal shell alone], + [`zig build -Dplatform=tui`], [the terminal shell alone], [`zig build -Dplatform=gui`], [the SDL3 window alone], [`zig build web -Dplatform=web -Dtarget=wasm32-freestanding -Ddump=<file>`], [a freestanding wasm core plus vanilla JavaScript (`docs/web.md`)], [`zig build -Dplatform=macos`], [an AppKit and CoreText app over a static `libpardes.a` (`docs/macos.md`)], @@ -45,7 +45,7 @@ there; its namespace is in `src/esp32p4_gpio.zig`. `zig build --help` lists the options for the selected platform. #pairs( - [`-Dplatform`], [`tty`, `gui`, `web`, `macos`, `esp32p4`; absent: the tty and SDL shells together, installed into `~/.local`], + [`-Dplatform`], [`tui`, `gui`, `web`, `macos`, `esp32p4`; absent: the tui and SDL shells together, installed into `~/.local`], [`-Dstatic`], [bool, `false`], [`-Dquic`], [bool, `false`: 9P over QUIC with system OpenSSL 3.6+], [`-Dmupdf`], [bool; on natively, off for web and esp32p4], @@ -75,7 +75,7 @@ zig build core-test core tests without native shell tests zig build pane-test pane, output, PDF and namespace integration tests zig build kitty-test kitty graphics conformance of terminal panes, at the core zig build kitty-harness kitty graphics through a pane end to end (a fake kitty - terminal outside on the tty, the GPU capture on the gui; + terminal outside on the tui, the GPU capture on the gui; kitten icat and chafa too when installed) zig build syntax-test tree-sitter tests without building the editor zig build syntax deterministic per-byte highlighting snapshots @@ -104,7 +104,7 @@ zig build cheatsheet render the cheatsheet PDF (needs typst) reading its diff, never all), `snap -- --no-retry` makes the first failure decisive. Snapshot scripts can use `snap9p` to capture core cells through 9P. -- `zig build monkey -Dplatform=tty -- <seeds> [steps] [--from=N] [--out=DIR] [--keep]` writes one random script per seed and keeps any +- `zig build monkey -Dplatform=tui -- <seeds> [steps] [--from=N] [--out=DIR] [--keep]` writes one random script per seed and keeps any that panics; a seed always makes the same script. Each crash found gets a fix and a regression script in `test/snapshots/`. - The tutor's practice blocks (`# keys:`, `# before`, `# after` in @@ -126,10 +126,10 @@ zig build cheatsheet render the cheatsheet PDF (needs typst) == Release gates -A release passes all of these first: `unit-test` with `-Dplatform=tty` and +A release passes all of these first: `unit-test` with `-Dplatform=tui` and with `-Dplatform=gui`, `core-test`, `behaviour-test`, `process-test`, `snap`, the GUI goldens (`python3 -B test/gui_golden.py <a Debug pardes-gui>`, a hidden window), -`web`, and the ReleaseSafe tty and ReleaseFast gui builds. The committed +`web`, and the ReleaseSafe tui and ReleaseFast gui builds. The committed `docs/typ/cheatsheet-a4.pdf` is rendered again when the docs change. = Sending patches <patches> @@ -142,7 +142,7 @@ Mail patches to the list `~gbrls/[email protected]`; it is the preferred way to = The core and its shells -One core, five shells (tty, gui, web, macos, esp32p4). The core owns +One core, five shells (tui, gui, web, macos, esp32p4). The core owns editing, layout, rendering and the virtual filesystem it serves over 9P; a shell turns native input into `pardes.Event`, presents `pardes.Surface`, and performs host effects such as spawning processes. @@ -165,7 +165,7 @@ effects such as spawning processes. that the tests use. Comptime decides what a build has (`pardes.platform`, `hosted`, `can_attach`, `terminal_panes`, `pdf_enabled`); the vtable decides who serves it. -- The root module is chosen by platform: `main.zig` (tty, gui), +- The root module is chosen by platform: `main.zig` (tui, gui), `web.zig`, `macos.zig`, `esp32p4.zig`. The web and macOS shells are libraries whose host owns `main()`. - `memory.limits` is the one home for capacities that differ on the ESP32-P4 |
