summaryrefslogtreecommitdiff
path: root/README.md
blob: 2c23de61d8b99f4b3a0a1fbb91a1f3fc5add012e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# 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 9P filesystem any program
can drive.

Install with Zig 0.16: `zig build -Dplatform=tty --prefix ~/.local`, then
run `pardes` or `pardes FILE`.

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