README.md rewritten sentence by sentence (closes #219) #228

Merged
clawbot merged 1 commits from issue-219-readme-rewrite into next 2026-10-26 17:48:26 +01:00
1 Commits
Author SHA1 Message Date
sneak 38e661a8de README.md rewritten sentence by sentence (closes #219)
check / check (push) Waiting to run
The old text served as the list of what to cover. The new text leads
with what quak is, what it is for and how to use it. Every command,
option, exit code and file layout follows in reference sections, then the
library reference, then design, entrypoints and development. Every
statement was checked against the code on next; the pull request lists
each disagreement. Sentences stay under about 30 words, tables are lists,
and no issue links or project history remain in text for users. Two code
comments now name the new README sections, and the one in
`src/cli-log.ts` matches "What quak prints" on stderr, stdout and exit
status; a third no longer cites the README.

Model: fable-5-1
2026-10-26 16:30:20 +00:00