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

Browse Source

The old text served as the list of what a reader needs covered. 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 places where
the old text disagreed with it are listed in the pull request. No sentence
runs past about 30 words, every table is now a list, and no issue links or
project history remain in text meant for users. Two code comments that
named README sections now name the new ones.

Model: fable-5-1

...

This commit is contained in:

sneak

2026-10-26 11:34:55 +00:00

parent a1ea47f9a8

commit c80651b43d

3 changed files with 1641 additions and 1234 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

README.md

+1639 -1232

File diff suppressed because it is too large Load Diff