summaryrefslogtreecommitdiff
path: root/docs/typ/install.typ
Commit message (Collapse)AuthorAge
* kinds #47, MuPDF and FreeType lazy: Zig 0.17's configure is handed the -D ↵Gabriel Schneider11 days
| | | | | | | options and never the steps asked for (the configurer's argv, and the configure cache keyed on it), so no step can fetch for itself; the guard is `-Dpdf`, on by itself once MuPDF is fetched (std.Build.package_map's `available`) and off Linux, which asks `b.lazyDependency` for MuPDF, and FreeType (with the zlib and libpng it brings) is lazy too and asked by it or a window: a fresh checkout's `zig build -Dplatform=tui` fetches none of them, and without `-Dpdf` the pdf, addons, static, mupdf-check, pdf-harness and bench steps say to add it; building.typ, install.typ and shared-libs.md say so Co-Authored-By: Claude Fable 5.1 <[email protected]> Claude-Session: https://claude.ai/code/session_016Y9MNAtZenFv4weoMD3cge
* kinds #24, the addons as build steps: `zig build image` and `zig build pdf` ↵Gabriel Schneider12 days
| | | | | | | 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
* kinds #17, the docs: reference.typ's Addons section says PDFs are an addon ↵Gabriel Schneider12 days
| | | | | | | (pdf.so, its jobs and lanes, ABI 2.1's additions), a kind's tag prefix, Look and search in a kind's pane, a dump's record; install.typ the second library; shared-libs.md what left the binaries; building.typ and the cheatsheet; the changelog one line Co-Authored-By: Claude Fable 5.1 <[email protected]> Claude-Session: https://claude.ai/code/session_016Y9MNAtZenFv4weoMD3cge
* kinds #11, the docs: reference.typ's Addons section says pictures are an ↵Gabriel Schneider12 days
| | | | | | | addon (addons/image/image.c, its formats and 1280-pixel cap, installed as <prefix>/lib/pardes/addons/image.so, an image file text without it), a job's allocations and /addons with no `static`; install.typ (in the setup) says the build installs image.so and a pardes without it shows image files as text; shared-libs.md says what left the binaries and the second decoder a process holds with image.so; the changelog one line Co-Authored-By: Claude Fable 5.1 <[email protected]> Claude-Session: https://claude.ai/code/session_016Y9MNAtZenFv4weoMD3cge
* rename: the terminal frontend is the tui (-Dplatform=tui, src/tui/tui.zig, ↵Gabriel Schneider13 days
| | | | | | | --tui with --tty kept as its old spelling, the process tests' backend .tui and --backend=tui, docs/typ/builtins-tui.json, the Settings report's platform), and the builtin Tty is Term (its registry entry, SPC n t, every default tag, the docs, tests and snap scripts), Tty still run as Term through exec.acme_words, Tty+fish too on a tag and a ctl; tty as a pane's raw mode and as the OS's terminal unchanged Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_016Y9MNAtZenFv4weoMD3cge
* Build with Zig 0.17Gabriel Schneider2026-10-22
| | | | | | | | | | | ghostty, libvaxis and uucode move to ghostty's 0.17 pins, cloud9 to its 0.17 main, SDL to castholm's release-3.4.x (3.4.18), zstbi and tree-sitter to forks with 0.17 build files (see build.zig.zon). A bare zig build copies the binaries into ~/.local/bin (-Dhome-install=false leaves it out): 0.17 keeps the prefix from build scripts. A terminal's edited copy goes when the program clears the screen. tinywin.snap is gone; perf baselines are re-recorded. Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The landing's words jump to their recordings, the casts open on their ↵Gabriel Schneider2026-10-01
| | | | | | | | | | | | | | | | | | | | | | | telling frame, and #mode-box draws the box Each recording on the landing has an anchor (rec-<name>); the "What's in it" words jump to theirs (Terminals, PDFs, Images, Diff review, Scripting) and the recording's caption ends in a link to the docs; Language servers and Themes, with no recording, link to the docs. A cast's `poster_at` in casts.toml picks the frame it shows until it plays: live-text at the error, terminals at the copied line, petscii on the Mandelbrot; the casts wait for the in-view script to play them. A caption may hold markup: the 9P clip links 9ns to setup. The downloads give their size, read from project.download, and the footer links the changes (project.changes). The guide's annotated pane has alt text, pin 1 beside the workspace tag rather than on Changelog, and pin 5 on the body's text; pin positions are written with repr, since str puts a U+2212 minus CSS cannot read. #mode-box(mark, unsaved:) draws a pane's box as it looks, in print and HTML. Co-Authored-By: Claude Opus 5.5 <[email protected]>
* Install offers the built pardes 0.23 binaries first, each with its checksum, ↵Gabriel Schneider2026-10-01
| | | | | | | | | | | | then building from source `project.download` in style.typ holds the version, the SHA256SUMS link and a file per program (the static terminal build and the window build, with what each needs); install.typ shows, for each, the curl, the sha256sum -c of its own checksum and the move into ~/.local/bin, then the clone and the build as the alternative. Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The landing shows each thing once, lists what is in pardes, and the guide ↵Gabriel Schneider2026-10-01
| | | | | | | | | | | | | | | | | | | | | | | | | opens on an annotated pane The window shelf drops terminals-are-panes (`landing = false` in clips.toml; the casts show it) and keeps the PDF, image, make, diff and 9P clips. Captions say what happens: the live-text cast renames a variable, runs make and lands on the error; the 9P clip is a shell under 9ns where the session is a directory. Casts stack one per row at the page's width, each showing a frame of itself until it plays. Under the lead, a row of linked chips names what is in pardes: terminals, PDFs, images, language servers, diff review, scripting, themes. Install says how long the first build takes (62 s from a clean cache on 16 cores, measured with the dependencies already fetched), and `project` in style.typ has a `download` slot (url, sha256, arch) install.typ shows once a binary exists. #annotated draws a screenshot with numbered pins and their labels as text beside it; the guide opens with one of the orchard theme's shot: the workspace tag, a column's tag, a pane's tag, the box, the body and the scrollbar, before its glossary. Co-Authored-By: Claude Opus 5.5 <[email protected]>
* Builtins are chips that link to a glossary generated from the registry, and ↵Gabriel Schneider2026-10-01
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | the virtual filesystem is drawn as a tree #word draws a builtin as a chip on the tag's ground over a rule (Look and Exec in acme's look green and exec red), a <code class="word"> in HTML, and links it to its entry in a new Builtins chapter wherever that chapter is in the same output (the book, the site). The chapter is drawn from docs/typ/builtins-tty.json and builtins-gui.json, which `zig build builtins-json -Dplatform=tty|gui` writes from the registry and the Help rows (src/builtins_json.zig, tools/gen_builtins_json.zig; summaryOf in ninep/ctl.zig is now pub); style.typ merges them, marking the window-only words. The doc steps refresh their build's file first, and each build's unit-test fails when its file is stale. Everyday words first (`everyday` in style.typ), then groups by leader prefix as Help has them, then settings, the words with no path, debugging and internals, and last an A-Z index of every word. `zig build book` joins the doc steps. #fstree draws a directory tree with its connectors, a description column and links to the sections that document each file; reference.typ draws the served tree with it, each pane, pty and column file on its own line, and a test in config.zig checks it against ninep/tree.zig's files both ways. The cheatsheet has a two-level version. On the site the tree reads as `tree` text in w3m and wraps descriptions under the names on a phone. The site's tutor draws its B1, B2, B3 and 1-2 chords as mouse glyphs; the landing credits Plan 9 and acme, as does the book's title page; install.typ no longer lists the mirrors (the footer does). Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The landing leads with live text and plays terminal casts first; the Themes ↵Gabriel Schneider2026-10-01
| | | | | | | | | | | | | | | | | | | | | | | | page gets a gallery; install starts at the clone The landing's own words sit in one `landing` record in site.typ: a lead on the core idea (any text is live: right-click looks, middle-click runs), where it runs, and a status line whose version is read from build.zig.zon. Recordings come in two shelves: "In a terminal", asciicast players from docs/site/casts/casts.toml (the first autoplays; all loop and fit the width; data inline, so they play from file://), then "In its own window", the GUI clips. asciinema-player 3.17.0 is vendored in docs/site/player with its Apache-2.0 licence, from `npm pack`. The Themes page shows #theme-gallery() from media/themes/themes.toml, a thumbnail per theme opening the full picture; on paper it is nothing. Both shelves and the gallery show placeholders until their files exist. `project` in style.typ lists the mirrors (sourcehut, git.0x4200.cafe); install.typ clones from the first and names them all, and the footer links each. The README clones before it builds. The scripting interface is a virtual filesystem served over 9P, never just a filesystem, in the tagline, captions and README. Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The landing shows the four recordings, pardes is ISC-licensed, and the ↵Gabriel Schneider2026-10-01
| | | | | | | | | | | | | | | | | install lines fit a phone clips.toml names the recordings (text-is-the-interface, terminals-are-panes, scripting-over-9p, diff-review), each ready, its caption checked against what the clip shows. The first ready clip plays at the top, full width and on its own (autoplay, muted, looping), and the grid below shows the others, three across. Videos and posters keep the recordings' 960x700 shape. The footer links the source at git.0x4200.cafe/pardes and names the ISC license, from `project` in style.typ. LICENSE holds the ISC text, and the README names it and says the libraries keep their own (MuPDF, on by default, is AGPL). The install lines put their comments on lines of their own, and on a phone a shell line wraps rather than scroll its end away. Co-Authored-By: Claude Opus 5.5 <[email protected]>
* The docs become a website: a page per chapter, a landing page with ↵Gabriel Schneider2026-10-01
recordings, one Typst bundle run docs/site/site.typ writes every page in one bundle compile: the landing page (the tagline, the recordings listed in media/clips.toml, links to start from), a page per entry of `chapters` in style.typ, and the tutor. Every page shares a tag-line header with the chapter words; #doc links resolve to the right page and anchor; a chapter with four or more sections gets an "On this page" list. Links are relative and pages flat, so it reads from file:// or any static server. `zig build site` installs it to <prefix>/share/doc/pardes/site and fails plainly without typst. The look is 0x4200.cafe's lapis layout (framed panels, hard shadows, a tag-line trail, Departure Mono headings over Crimson Pro) in orchard's greens and amber, forestbones_light when the reader prefers light; both fonts are OFL and shipped. In HTML a key is one pill with its + and ›, and a mouse button is an inline SVG in currentColor. The tagline lives once in style.typ for the sheet, the book and the site, and the single page html.typ gives way to the site. The landing leads with one plain sentence (columns of panes, click to run or open, helix keys, scripts through files), then the tagline and a line on where it runs; a hero image is the first ready clip's poster; "Start: the guide" leads the links, "Hands on: the tutor" next, the rest a plain row; the captions use no undefined words. docs/typ/install.typ holds the install lines once: setup.typ has an Install section that includes it, and the landing includes it too. Building says up front it is for contributors and points at setup to install. In HTML the guide's glossary is a closed <details> (#glossary, the same heading and table on paper), each drawn mouse carries hidden text (left-click, hold left, click middle) for screen readers, w3m and copying, and the footer takes a source link and a licence from `project` in style.typ once decided. Co-Authored-By: Claude Opus 5.5 <[email protected]>