Rewrite README.md sentence by sentence for a newcomer

Browse Source

Rewrites `README.md` from scratch for #135, so that a newcomer can follow each sentence on one reading. It leads with what the program is and how to use it, then the reference, then development. Where the old text and the code disagreed, it states what the code does; #140 lists each point. Test comments that cited moved text cite the new headings.

Review scope: full reviews through the 16th, then only text changed since.
Dropped: the permission to add `github.com/spf13/viper`.

Model: fable-5-1 (rewrite); opus-5-5 (review, landing message)

This commit was merged in pull request #140.

...

This commit is contained in:

clawbot

2026-11-02 23:12:27 +01:00

parent 4ed2e370b1

commit 2322f8bb02

6 changed files with 1097 additions and 943 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

+1066 -922

File diff suppressed because it is too large Load Diff