summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-10-01 10:45:29 -0300
committerGabriel Schneider <[email protected]>2026-10-01 12:24:31 -0300
commit351c3976805aa12a56c593894738001491548106 (patch)
tree9f0fa22bb249d559092254ee5502af9f6455f505 /README.md
parent9e30f716e73b4b830b0fde7c5142d8f6b8deb511 (diff)
downloadpardes-351c3976805aa12a56c593894738001491548106.tar.gz
pardes-351c3976805aa12a56c593894738001491548106.zip
The docs trimmed to their path: a guide with Words you'll see and one Where commands run and panes go table, scripting's first tag word Fmt and eight traps, setup as the one home of the pager and the servers, a scannable cheatsheet, an honest README, the edge cases moved to the reference, and the pager's colours
Co-Authored-By: Claude Opus 5.5 <[email protected]>
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 14 insertions, 22 deletions
diff --git a/README.md b/README.md
index 22ba334a..2c23de61 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,19 @@
# pardes
-A text environment in the acme tradition: columns of panes, each a tag line
-over a body that is a file, a live terminal, a PDF or an image. The mouse
-carries meaning (left selects, middle executes, right looks), the keyboard
-is helix's, and every session serves its panes as a 9P filesystem, so any
-program that opens files can drive it.
+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.
-Install the terminal build with Zig 0.16: `zig build -Dplatform=tty
---prefix ~/.local` puts `pardes` in `~/.local/bin` (a bare `zig build` builds
-the SDL window too and installs both there). Run `pardes`, or `pardes FILE`.
+Install with Zig 0.16: `zig build -Dplatform=tty --prefix ~/.local`, then
+run `pardes` or `pardes FILE`.
-Read next: the [guide](docs/typ/guide.typ) (10 minutes),
-[setup](docs/typ/setup.typ) for the shell, editor and mount around it, the
-[cheatsheet](docs/typ/cheatsheet.typ) (3 minutes), then
-[scripting](docs/typ/scripting.typ) (5 minutes); the
-[reference](docs/typ/reference.typ) and [themes](docs/typ/themes.typ) when
-you need them. They build into one PDF with `typst compile --root .
---ignore-system-fonts docs/typ/book.typ`, and `zig build cheatsheet
--Dplatform=tty --prefix DIR` renders the cheatsheet to
-`DIR/share/doc/pardes/cheatsheet.pdf` (the committed copy is
-[docs/typ/cheatsheet-a4.pdf](docs/typ/cheatsheet-a4.pdf)). Inside pardes,
-`Tutor` walks through the same ground.
+Read the [guide](docs/typ/guide.typ) (about 10 minutes), then try `Tutor`
+inside pardes (about 15). Keep the [cheatsheet](docs/typ/cheatsheet.typ)
+beside you. Read [scripting](docs/typ/scripting.typ) (about 10) when you
+want to drive it from programs, and [setup](docs/typ/setup.typ) when you
+fit it into your shell and tools. The [reference](docs/typ/reference.typ)
+has every detail. `typst compile --root . --ignore-system-fonts
+docs/typ/book.typ` builds them into one PDF.
-Contributors: [building](docs/typ/building.typ) has the platforms, build
-options, tests, release gates and how the core, the shells and the 9P
-server fit together.
+Contributors: [building](docs/typ/building.typ).