Rewrite README.md sentence by sentence for a newcomer
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. Where the old text and the repository disagreed, the new text states what the code does. #140 lists every such point. Among them: `@latest` installs the newest tagged release, ten million files in both "Rationale" and "Design", no Windows excludes, a relative operand is joined to the working directory as `pwd` prints it, 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:
@@ -29,6 +29,14 @@
|
||||
|
||||
# Completed Steps
|
||||
|
||||
- `README.md` rewritten from scratch, sentence by sentence, as a newcomer reads
|
||||
it. It leads with what the program is and how to use it. A reference section
|
||||
covers every setting and every subcommand. Development and testing come last.
|
||||
Every statement was checked against the code on `next`. Five comments in
|
||||
`main_test.go` cite "Settings", where their rules now live. One comment each
|
||||
in `scan_test.go`, `trees_test.go` and `exclude_test.go` cites what the README
|
||||
now says (2026-11-02, https://git.eeqj.de/sneak/sfdupes/issues/135)
|
||||
|
||||
- each record holds `disk_size`, the bytes the file takes on disk: its allocated
|
||||
blocks, `st_blocks` × 512, from the lstat the walk already does. `trees`
|
||||
prints a `disk_size` column after `size`, the sum over the `dupe` copy's
|
||||
|
||||
Reference in New Issue
Block a user