From c0bcb4882f47db9d8d95d88af8ad24526d4f7be3 Mon Sep 17 00:00:00 2001 From: Nicholas Karlson Date: Sat, 7 Feb 2026 10:07:16 -0800 Subject: [PATCH] docs: align canonical commands + demo verify gate --- .github/workflows/ci.yml | 1 + Makefile | 8 +++++--- README.md | 11 +++++++++++ docs/HANDOFF.md | 11 +++++++++++ 4 files changed, 28 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e70af2a..4cc866c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -17,3 +17,4 @@ jobs: with: go-version: 'stable' - run: go test -count=1 ./... + - run: go run ./cmd/normalizer demo --out ./out/demo diff --git a/Makefile b/Makefile index e3265a4..77be875 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -.PHONY: test fmt build demo clean +.PHONY: test fmt build demo verify clean VERSION ?= dev @@ -12,8 +12,10 @@ build: mkdir -p bin go build -ldflags "-X main.version=$(VERSION)" -o bin/normalizer ./cmd/normalizer -demo: build - ./bin/normalizer demo --out ./out/demo +demo: + go run ./cmd/normalizer demo --out ./out/demo + +verify: test demo clean: rm -rf ./bin ./out diff --git a/README.md b/README.md index d58eb5d..6900849 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,17 @@ Deterministic CSV normalizer + validator. - `errors.csv` - `report.json` +## Canonical commands + +```bash +# Proof gate (one command) +make verify + +# Proof gates (portable, no Makefile) +go test -count=1 ./... +go run ./cmd/normalizer demo --out ./out/demo +``` + ## Quickstart ```bash diff --git a/docs/HANDOFF.md b/docs/HANDOFF.md index 3456903..d58ce50 100644 --- a/docs/HANDOFF.md +++ b/docs/HANDOFF.md @@ -2,6 +2,17 @@ This tool normalizes CSV inputs deterministically and produces a clean output + an error file. +## Canonical commands + +```bash +# Proof gate (one command) +make verify + +# Proof gates (portable, no Makefile) +go test -count=1 ./... +go run ./cmd/normalizer demo --out ./out/demo +``` + ## Build ```bash