max / shop

README: say what shop actually is right now "Pre-code. Bootstrap in progress." stopped being true several thousand lines ago, and this README is what makenot.work renders on a repo overview page, so it is the first thing a visitor reads. State the real position instead: the binary opens a window and runs a shell on a PTY, shop-vt exists but is not wired into it, so escapes are still garbage. Taken from main.rs's own milestone comment, which was accurate. Two other over-claims out: kittygfx is not on crates.io yet, and the layout listed shop-xkb and shop-sixel as though they existed. The Alloy link pointed at ~maxjmath, which is not the account; the repo is ~maxmj/alloy. It 404s either way until that repo goes public (GO 38fcbb30), but it should at least name the right account.

Author: Max Johnson <me@maxj.phd> · 2026-07-25 14:01 UTC

Signed with PGP, not checked

Commit: 7b0453a77b4e82964c678eb97f0c15baf999f261

Parent: c692498

1 file changed, +14 insertions, -8 deletions

M README.md +14 -8

			@@ -2,23 +2,29 @@
2	2
3	3		Wayland-only, GPU-accelerated terminal emulator. Foot-inspired: small,
4	4		focused, no built-in tabs/splits (the compositor or a multiplexer does that).
5		-	Adds the three things
6		-	foot refuses to do — GPU rendering, Kitty graphics protocol, ligatures.
	5	+	Adds the three things foot refuses to do: GPU rendering, Kitty graphics
	6	+	protocol, ligatures.
7	7
8		-	Ships as the default terminal in [Alloy](https://git.sr.ht/~maxjmath/alloy).
	8	+	Ships as the default terminal in [Alloy](https://git.sr.ht/~maxmj/alloy).
9	9		Standalone-usable on any Wayland compositor.
10	10
11	11		## Status
12	12
13		-	Pre-code. Bootstrap in progress.
	13	+	Pre-v0.1, and not yet daily-drivable. The workspace builds and the binary opens
	14	+	a Wayland window, runs a shell on a PTY, and renders its output: `ls`, `echo`
	15	+	and `printf` look right. The VT parser is written as `shop-vt` but is not wired
	16	+	into the binary yet, so escape sequences still render as garbage and vim and
	17	+	htop do not look right. No input handling crate (`shop-xkb`) and no sixel yet.
14	18
15	19		## Layout
16	20
17	21		- `crates/shop/` — the binary.
18		-	- `crates/kitty-graphics/` — public library (published to crates.io):
19		-	rendering-agnostic Kitty graphics protocol parser.
20		-	- `crates/shop-{vt,grid,render,wayland,xkb,pty,sixel}/` — added as each
21		-	component is implemented. See design hub.
	22	+	- `crates/kitty-graphics/` — the public library, package name `kittygfx`:
	23	+	a rendering-agnostic Kitty graphics protocol parser. Headed for crates.io,
	24	+	not published yet.
	25	+	- `crates/shop-{vt,grid,render,wayland,pty}/` — present. `shop-xkb` (input)
	26	+	and `shop-sixel` are not written yet; each crate is added as its component
	27	+	is implemented. See design hub.
22	28
23	29		## Non-goals
24	30