summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-10-01 12:41:34 -0300
committerGabriel Schneider <[email protected]>2026-10-01 12:41:34 -0300
commit3c1668e02395d41bb83a4df3d85bf47a7bbdbef4 (patch)
tree93c25d9365a0800703f5f9ec2d81fe6acec59b3a /README.md
parent9a7830c62d25d83754bd58d0e705501f71656c69 (diff)
downloadpardes-3c1668e02395d41bb83a4df3d85bf47a7bbdbef4.tar.gz
pardes-3c1668e02395d41bb83a4df3d85bf47a7bbdbef4.zip
The landing leads with live text and plays terminal casts first; the Themes 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]>
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index c16453b5..3a566d2a 100644
--- a/README.md
+++ b/README.md
@@ -2,10 +2,12 @@
A text environment in the acme tradition: columns of panes, each a tag over
a file, a terminal, a PDF or an image. Left selects, middle executes, right
-looks; the keys are helix's; every session is a 9P filesystem any program
-can drive.
+looks; the keys are helix's; every session is a virtual filesystem, served
+over 9P, that any program can drive.
-Install with Zig 0.16: `zig build -Dplatform=tty --prefix ~/.local` for
+Get the source with `git clone https://git.sr.ht/~gbrls/pardes && cd pardes`
+(also at https://git.0x4200.cafe/pardes). Install with Zig 0.16:
+`zig build -Dplatform=tty --prefix ~/.local` for
`pardes` in a terminal, or `-Dplatform=gui` for the `pardes-gui` window.
The terminal should report the mouse; Shift-Esc needs the kitty keyboard
protocol, and images need kitty graphics (else they are drawn as PETSCII