Add the required README sections (closes #75) #105

Merged
clawbot merged 1 commits from issue-75-readme-sections into next 2026-10-04 06:32:08 +02:00
1 Commits
Author SHA1 Message Date
sneak 649c230096 Add the required README sections (closes #75)
check / check (push) Successful in 1m39s
The Description first line now names the project, purpose, category,
WTFPL license, and author. A new Getting Started section gives a
copy-pasteable build-from-source block and gen/check/fetch usage. Problem
Statement and Proposed Solution move under a new Rationale heading, the
prose kept. A new Design section documents the package layout: the mfer/
library with its committed protobuf code, the internal/cli commands,
internal/log and internal/bork, and the cmd/mfer entrypoint. Authors is
renamed Author with the canonical link.

Getting Started uses go build because the make target that builds the
binary runs protoc, which script/bootstrap does not install.

Model: opus-4-8 (implementation); opus-5-5 (rebase, rework)
2026-10-04 02:43:55 +00:00