# 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.

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`.

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.

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.