Read the two docs the handover named; drop the duplicated test procedure and list both in DOCMAP
This commit is contained in:
22
README.md
22
README.md
@@ -47,24 +47,10 @@ TUIOS it has to close a box.
|
||||
|
||||
## How an interface change is tested
|
||||
|
||||
This machine runs TUIOS, and the program is used inside a TUIOS pane. A test in a plain
|
||||
terminal, or in tmux, only proves that a program draws and survives a resize message. It
|
||||
does not prove the program works where it will actually run, because TUIOS owns part of
|
||||
the keyboard and sends its own resize messages.
|
||||
|
||||
So an interface change is checked by putting it in a real TUIOS pane and reading the pane
|
||||
back:
|
||||
|
||||
```bash
|
||||
tuios new-window -s "$TUIOS_SESSION" harness-check --no-focus --keep-open -- /tmp/harness-bin -project spike-2026-11-10
|
||||
tuios capture-pane -s "$TUIOS_SESSION" -w harness-check
|
||||
tuios send-keys -s "$TUIOS_SESSION" -w harness-check Down --repeat 2
|
||||
tuios screenshot -w harness-check -o /tmp/harness-tuios.png
|
||||
tuios close-window harness-check
|
||||
```
|
||||
|
||||
`--no-focus` keeps the person's focus where it was, and the pane is closed afterwards, so
|
||||
the layout is left as it was found.
|
||||
Not in a plain terminal, and not in tmux. TUIOS owns part of the keyboard and forwards
|
||||
clicks relative to the pane, so the check is a real TUIOS pane read back with
|
||||
`capture-pane`. The commands are in `docs/TUIOS-RUNBOOK.md`, which is the one place they
|
||||
live.
|
||||
|
||||
## Rules for this project
|
||||
|
||||
|
||||
@@ -7,6 +7,8 @@ it is a pointer and should be deleted or replaced.
|
||||
|---|---|---|
|
||||
| `README.md` | project root | where to start, what is installed, the rules |
|
||||
| `AGENTS.md` | project root | instructions for the agent: what to build, which key, the first test |
|
||||
| `docs/OPERATING-RULES.md` | this project | the nine rules that are not preferences: project convention, how a task is judged finished, approvals, secrets, cost |
|
||||
| `docs/TUIOS-RUNBOOK.md` | this project | the environment is TUIOS not tmux: workspaces, panes, the machines, how sessions start, how to test an interface |
|
||||
| `HANDOVER.md` | project root | what we tried before, what worked, what failed, the pitfalls |
|
||||
| `CHECKLIST.md` | project root | the next session, step by step, with tick boxes |
|
||||
| `docs/OPERATING-RULES.md` | this project | the nine rules: project folder, how work is judged, approvals, untrusted text, secrets, review and merge, one project per machine, cost, existing commands |
|
||||
|
||||
Reference in New Issue
Block a user