Slim README to a one-screen summary #48

Closed
opened 2026-10-20 19:14:22 +00:00 by mintopia · 2 comments
Owner

What to build

README.md becomes a one-screen repo summary that links into the site: pitch, own-copy note, screenshot, download and docs links, a short build quickstart, a short layout table, a contributing pointer and a licence/disclaimer summary.

Acceptance criteria

  • README fits on roughly one screen
  • Detail removed from README exists on the site
  • Every README link resolves

See ADR 0021 (docs site) and ADR 0022 (online service host).

## What to build README.md becomes a one-screen repo summary that links into the site: pitch, own-copy note, screenshot, download and docs links, a short build quickstart, a short layout table, a contributing pointer and a licence/disclaimer summary. ## Acceptance criteria - [ ] README fits on roughly one screen - [ ] Detail removed from README exists on the site - [ ] Every README link resolves See ADR 0021 (docs site) and ADR 0022 (online service host).
mintopia added this to the Docs site milestone 2026-10-20 19:14:22 +00:00
Author
Owner

README.md slimmed 159 -> 51 lines (commit 2e5c2ab): pitch, own-copy note, screenshot, release + docs links, short build quickstart, layout table, contributing pointer, licence/disclaimer summary. Removed detail (install, status, online, env vars, full build, credits, full disclaimer) already exists in docs/ (play-macos*, known-limitations, build-from-source, repo-structure, legal, THIRD_PARTY_NOTICES). All README links verified to resolve to existing files/pages.

README.md slimmed 159 -> 51 lines (commit 2e5c2ab): pitch, own-copy note, screenshot, release + docs links, short build quickstart, layout table, contributing pointer, licence/disclaimer summary. Removed detail (install, status, online, env vars, full build, credits, full disclaimer) already exists in docs/ (play-macos*, known-limitations, build-from-source, repo-structure, legal, THIRD_PARTY_NOTICES). All README links verified to resolve to existing files/pages.
Author
Owner

Completed and merged by Harmonic (task 42).

Completed and merged by Harmonic (task 42).
Sign in to join this conversation.
No description provided.