README: install, cron deployment, and how to read the reports #54

New Issue

2026-09-21T09:17:52+02:00

clawbot commented

2026-09-21 09:17:52 +02:00

README.md §Getting Started is a five-line make build example. A
first-time user of a 1.0 cannot learn from the repo how to install the
tool, how to set up the daily scan the design is built around, or what
to do with the two reports. Everything below is documentation; no code
changes.

Definition of done

§Getting Started gains an install section: go install sneak.berlin/go/sfdupes@latest (verify that the vanity import path
actually resolves before documenting it; if it does not, say so on
the PR and document git clone plus make build only), and the
Docker image with a bind-mounted scan path and database.
A cron deployment example: the crontab line, which user it runs
as, where the database lives by default, and how stderr is
captured (the non-TTY progress lines and the summary line).
A short "Reading the reports" section: what first and dupe
mean, that the match is a candidate signal and not proof, that
hard-linked paths are listed although removing one frees nothing,
and a worked example of verifying one candidate pair with
cmp before removing anything.
--workers, -x, --version and --help each appear in the
usage block or the text around it.
Every sentence added is true of the tree it merges into: each
command shown has been run, and nothing is promised that the
code does not do.
Markdown formatted with make fmt once
#19 has landed.

Depends on #19 (formatting)
and #15 (--version
behaviour it documents).

Model: fable-5-1

`README.md` §Getting Started is a five-line `make build` example. A first-time user of a 1.0 cannot learn from the repo how to install the tool, how to set up the daily scan the design is built around, or what to do with the two reports. Everything below is documentation; no code changes. ## Definition of done 1. §Getting Started gains an install section: `go install sneak.berlin/go/sfdupes@latest` (verify that the vanity import path actually resolves before documenting it; if it does not, say so on the PR and document `git clone` plus `make build` only), and the Docker image with a bind-mounted scan path and database. 2. A cron deployment example: the crontab line, which user it runs as, where the database lives by default, and how stderr is captured (the non-TTY progress lines and the summary line). 3. A short "Reading the reports" section: what `first` and `dupe` mean, that the match is a candidate signal and not proof, that hard-linked paths are listed although removing one frees nothing, and a worked example of verifying one candidate pair with `cmp` before removing anything. 4. `--workers`, `-x`, `--version` and `--help` each appear in the usage block or the text around it. 5. Every sentence added is true of the tree it merges into: each command shown has been run, and nothing is promised that the code does not do. 6. Markdown formatted with `make fmt` once https://git.eeqj.de/sneak/sfdupes/issues/19 has landed. Depends on https://git.eeqj.de/sneak/sfdupes/issues/19 (formatting) and https://git.eeqj.de/sneak/sfdupes/issues/15 (`--version` behaviour it documents). Model: fable-5-1

clawbot added this to the 1.0.0 milestone 2026-09-21 09:17:52 +02:00

clawbot referenced this issue

2026-09-21 09:18:34 +02:00

Review toward 1.0: identify and file all next steps #52

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: sneak/sfdupes#54