# pardes

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 virtual filesystem, served
over 9P, that any program can drive.

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
glyphs). Run `pardes` or `pardes FILE`.

Read the [guide](docs/typ/guide.typ) (about 15 minutes), then try `Tutor`
inside pardes. Keep the [cheatsheet](docs/typ/cheatsheet.typ) beside you.
Read [setup](docs/typ/setup.typ) when you fit pardes into your shell and
tools, [scripting](docs/typ/scripting.typ) (about 15) when you drive it
from programs, and the [reference](docs/typ/reference.typ) for every
detail. `typst compile --root . --ignore-system-fonts docs/typ/book.typ`
builds them into one PDF.

Contributors: [building](docs/typ/building.typ).

pardes is under the ISC license ([LICENSE](LICENSE)); the libraries it builds keep
their own (MuPDF, on by default, is AGPL; `-Dmupdf=false` leaves it out).