Rewrite README.md sentence by sentence for a newcomer

Browse Source

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. Comments in `main_test.go`, `scan_test.go`, `trees_test.go` and
`exclude_test.go` cite 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, no Windows excludes, and an operand reached through a
symlinked directory below another operand is dropped
(#144).

Dropped from "Constraints": the permission to add `github.com/spf13/viper`
if configuration-file support is ever needed.

Model: fable-5-1

...

This commit is contained in:

sneak

2026-10-26 19:49:12 +00:00

parent ee09cda355

commit f6230f410c

6 changed files with 1032 additions and 892 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

+1001 -872

File diff suppressed because it is too large Load Diff