Following the issue-first rule in CONTRIBUTING.md. Happy to close this if it's out of scope.
The gap
The README goes straight from "Built in the open" into Install. Neither it nor anything under docs/ has a Requirements or Prerequisites heading, so a reader learns the prerequisites by hitting failures.
abcd shells out to the git binary (internal/gitutil/repo.go:32, internal/gitutil/gitignore.go:35) and anchors every record it keeps to a repository, so git is a hard runtime dependency that nothing above the install mentions. I installed on a machine without git or Go and had to work out both from errors.
Proposed
A five-bullet Requirements section above Install, each bullet scoped to when it actually applies rather than presented as a flat prerequisite list:
- Git — always.
- Platform — macOS/Linux on amd64/arm64; Windows via WSL.
- An agent harness — the plugin route and the agent-delegating verbs only, reflecting the host-delegated design in adr-25. The deterministic verbs need none.
curl + a SHA-256 tool — the CLI one-liner only.- Go 1.26+ — a source build only; explicitly not needed to install, since both routes provision a prebuilt binary.
Second, smaller thing
The README still names Partnermedia in the badges, the releases link, the /plugin marketplace add command and the CLI one-liner's download URLs. Those work only via GitHub's 301 redirect. Scoped to the README's user-facing occurrences — the go.mod module path and its ~450 in-tree references are untouched, as that's a module rename rather than a docs fix.
Ready if you want it
Branch: https://github.com/andytwoods/abcd/tree/docs/readme-requirements — one commit, abcd docs lint reports 0 blockers.
It does not yet carry the CHANGELOG entry your process requires; I'll add that if this is accepted.
Following the issue-first rule in
CONTRIBUTING.md. Happy to close this if it's out of scope.The gap
The README goes straight from "Built in the open" into Install. Neither it nor anything under
docs/has a Requirements or Prerequisites heading, so a reader learns the prerequisites by hitting failures.abcdshells out to thegitbinary (internal/gitutil/repo.go:32,internal/gitutil/gitignore.go:35) and anchors every record it keeps to a repository, so git is a hard runtime dependency that nothing above the install mentions. I installed on a machine without git or Go and had to work out both from errors.Proposed
A five-bullet Requirements section above Install, each bullet scoped to when it actually applies rather than presented as a flat prerequisite list:
curl+ a SHA-256 tool — the CLI one-liner only.Second, smaller thing
The README still names
Partnermediain the badges, the releases link, the/plugin marketplace addcommand and the CLI one-liner's download URLs. Those work only via GitHub's 301 redirect. Scoped to the README's user-facing occurrences — thego.modmodule path and its ~450 in-tree references are untouched, as that's a module rename rather than a docs fix.Ready if you want it
Branch: https://github.com/andytwoods/abcd/tree/docs/readme-requirements — one commit,
abcd docs lintreports 0 blockers.It does not yet carry the CHANGELOG entry your process requires; I'll add that if this is accepted.