scripts-to-rule-them-all (#58)

Reviewed-on: #58
Co-authored-by: sneak <sneak@sneak.berlin>
Co-committed-by: sneak <sneak@sneak.berlin>

README.md

@@ -25,8 +25,39 @@ software. A compatible javascript library is planned.
 
 # Build Status
 
-CI runs via `docker build .` which executes `make check` (formatting,
-linting, tests). The `main` branch must always be green.
+CI runs via `script/cibuild` (`docker build .`), which executes `make
+check` (formatting, linting, tests). The `main` branch must always be
+green.
+
+# Entrypoints
+
+This repository adheres to the
+[Scripts to Rule Them All](https://github.com/github/scripts-to-rule-them-all)
+standard: normalized scripts in `script/` are the entrypoints for the
+development workflow, and the Makefile targets are thin shims that call
+them. We provide:
+
+- `script/bootstrap` — install all dependencies (Go, golangci-lint, Go
+  module download), idempotently
+- `script/setup` — make a fresh clone ready for development: runs
+  `script/bootstrap`, then `script/install-precommit`
+- `script/projectname` — output the project name (`mfer`); used by other
+  scripts such as `script/docker`
+- `script/test` — run the test suite (`go test`), regenerating the
+  protobuf code first if it is stale
+- `script/lint` — run `golangci-lint` and verify `gofmt` cleanliness
+- `script/fmt` — format all code and docs (writes): `gofumpt`,
+  `golangci-lint run --fix`, and prettier for JSON/Markdown
+- `script/fmt-check` — check formatting without writing
+- `script/check` — run `script/test`, `script/lint`, and
+  `script/fmt-check`
+- `script/docker` — build the Docker image tagged with the project name
+- `script/cibuild` — CI entrypoint: `docker build .` (the Dockerfile
+  runs the checks)
+- `script/precommit` — pre-commit checks: `go mod tidy` verification,
+  then `script/check`
+- `script/install-precommit` — install the git pre-commit hook that
+  runs `script/precommit`
 
 # Participation
 
@@ -126,6 +157,7 @@ The manifest file would do several important things:
 # Open Questions
 
 - Should the manifest file include checksums of individual file chunks, or just for the whole assembled file?
+
   - If so, should the chunksize be fixed or dynamic?
 
 - Should the manifest signature format be GnuPG signatures, or those from