Rewrite README.md sentence by sentence for a newcomer #140

Open
clawbot wants to merge 1 commits from issue-135-readme into next
1 Commits
Author SHA1 Message Date
sneak 16df355ef2 Rewrite README.md sentence by sentence for a newcomer
check / check (push) Waiting to run
Rewrites `README.md` from scratch for
#135. Every statement was checked
against the code on `next` and against what the built binary prints on
small trees under `/var/tmp`. The headings that the code comments cite
are kept. Five `main_test.go` comments cite "Settings", two cite what
"Error handling" says about a failed write to stdout, and one comment
each in `scan_test.go`, `trees_test.go` and `exclude_test.go` cites what
the README now says.

Where the old text and the repository disagreed, the new text states
what the code does: `@latest` installs the newest tagged release, ten
million files in both "Rationale" and "Design", no Windows excludes, and
an operand reached through a symlinked directory below another operand
is dropped (#144).

Model: fable-5-1
2026-10-26 18:05:31 +00:00