P7: parity enforcement & docs - the platforms standard is binding
- CLAUDE.md gains the Platforms section: the two flavours, the on_platform binding rule, the glyph/palette/fold contracts, the fontset<->font-script same-commit coupling, F-lane grammar, and the specimen as the acceptance card. The 72-column rule becomes readable_cols-per-platform with the gallery as the enforcement point. - README quick start: the auto-detected PicoCalc flavour, the desktop preview flag, meshterm specimen, and the bring-up scripts. - The plan file is archived with per-phase outcomes, the P3 rework record, solo-decision log for JP, and the left-on-the-table list. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
1 parent
f21817b816
commit
e425e8fc41
2 files changed
+42
-1
No files matched your search
@@ -5,7 +5,10 @@ prompt_toolkit session rendering Rich content (`meshterm/ui/`), tools register i
|
||||
menu (`meshterm/tools/`), services run in the background (`meshterm/services/`), and
|
||||
everything heard is recorded to SQLite (`meshterm/persistence/`).
|
||||
|
||||
Run the tests with `python -m pytest -q`. Screens must stay readable at 72 columns.
|
||||
Run the tests with `python -m pytest -q`. Screens must stay readable at each platform's
|
||||
`readable_cols` — 72 regular, 53 PicoCalc (see **Platforms** below); the dual-platform
|
||||
gallery test (`tests/test_gallery.py`) is the enforcement point, and every picocalc case
|
||||
is a hard gate.
|
||||
|
||||
## Git workflow
|
||||
|
||||
@@ -146,3 +149,32 @@ Relative ages: `format_ago` for prose ("now", "5m ago", "never" — never "now a
|
||||
- Dialogs anchor slightly above true centre, sized for their populated state.
|
||||
- Radio traffic: single transmissions or a user-chosen sample count with cooldown pacing
|
||||
— never bursts.
|
||||
|
||||
### Platforms
|
||||
|
||||
One codebase, two flavours: **regular** (desktop/ssh, 72 cols, truecolor, emoji) and
|
||||
**picocalc** (the PicoCalc's 53×26/53×40 framebuffer console, 16 palette slots, a
|
||||
512-glyph font, no emoji). A frozen `Platform` spec (`meshterm/platforms.py`) resolves
|
||||
once at boot; consumers bind at platform-switch time via `platforms.on_platform` — never
|
||||
branch on the platform per frame, and never `from meshterm.platforms import PLATFORM`.
|
||||
|
||||
- **Never emit a raw emoji or bare hex colour into picocalc output.** Icons go through
|
||||
`theme.glyph()` (the compact map); everything else is caught by the render-boundary
|
||||
fold (`theme.fold_text`, applied in `tui/render.render_to_ansi` and
|
||||
`MapCanvas.to_ansi_lines`) — but the fold is the safety net, not the design.
|
||||
- The glyph contract is `ui/fontset.py` — the installed console font's exact codepoint
|
||||
inventory, device-verified. A character outside it is a test failure, not a tofu box
|
||||
found on-device. The font itself is built by `scripts/calculinux-console-font.sh`;
|
||||
the two files move in the same commit.
|
||||
- The 16-slot palette is `theme._VT_SLOTS` (programmed via `/etc/vtrgb`; same script).
|
||||
`MESH_THEME_16` speaks `color(0..15)` only; bold is brightness on the VT (never bold
|
||||
slots 5/6); backgrounds stop at slot 7. Both themes define identical style names.
|
||||
- On picocalc, names colour by node **type** (`core/nodetypes` registry), heat
|
||||
quantizes to the `heat.*` steps, and footer hints are replaced by the **F-key lane**
|
||||
(`ui/tui/fkeys.py`): five `FPair` slots per screen, F1–F5 primary and F6–F10 their
|
||||
paired opposites (physical Shift+F1..F5), labels ≤7 cells. Screens override
|
||||
`fkey_lane` for their own verbs; slots 3/4 are the customary free pair.
|
||||
- `meshterm specimen` prints the whole visual language through the real funnels — the
|
||||
acceptance card on-device, a preview under `--platform picocalc` on the desktop.
|
||||
- Dev loop: `meshterm --mock --platform picocalc` in a 53×40 window; the gallery and
|
||||
`tests/test_theme16.py` carry the contracts.
|
||||
@@ -75,8 +75,17 @@ meshterm --tcp 192.168.1.50 info
|
||||
|
||||
# No radio attached? Use the built-in simulator for development.
|
||||
meshterm --mock
|
||||
|
||||
# On a ClockworkPi PicoCalc (Luckfox Lyra / Calculinux) the handheld flavour is
|
||||
# auto-detected: a 53-column layout, a 16-slot palette, a compact glyph language on a
|
||||
# custom console font, and an F-key hint lane. Preview it anywhere, or inspect it:
|
||||
meshterm --mock --platform picocalc
|
||||
meshterm specimen
|
||||
```
|
||||
|
||||
Handheld bring-up (fonts, palette, boot services) lives in
|
||||
`scripts/calculinux-setup.sh` + `scripts/calculinux-console-font.sh`.
|
||||
|
||||
## Features
|
||||
|
||||
MeshTerm's menu is organised into four sections. Every interactive screen is listed here
|
||||
|
||||
Reference in new issue
Block a user