Skip to content

docs: README surface cut (install, smoke, harness, links) - #8

Merged
makefunstuff merged 5 commits into
mainfrom
docs/readme-surface-cut
Sep 22, 2026
Merged

makefunstuff merged 5 commits into
mainfrom
docs/readme-surface-cut

Conversation

@makefunstuff

Copy link
Copy Markdown
Owner

Summary

Cut README to the surface Juri asked for (~90 lines):

  1. Lede + demo gif
  2. Install (clank-cli-app, never bare clank, git fallback)
  3. 30s smoke
  4. Harness cost (dated) — history numbers only
  5. Link table to CHEATSHEET / PROTOCOL / docs

Parked out of README: Unix contract essay, --each deep dive, tools/config matrices, Design/Verified/Provenance, docker LOC flex, laptop 40583 defaults, duplicate pong in Install.

Supersedes the order-only work on #7 if still open — this PR includes Install → smoke → Harness.

Test plan

  • tests/docs.rs (flags still in CHEATSHEET)
  • reflow check
  • Glance ≤150 lines, no Speed hero title

@makefunstuff
makefunstuff merged commit ab44a62 into main Sep 22, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant