diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 12 insertions, 9 deletions
@@ -5,15 +5,18 @@ 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`. +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 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. +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). |