Skip to content

Commit 7f078d3

Browse files
committed
update README
1 parent be0a56a commit 7f078d3

1 file changed

Lines changed: 19 additions & 10 deletions

File tree

README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ cd agentic-control-plane
6767
make build # writes bin/agentctl
6868
```
6969

70-
Or: `go install ./cmd/agentctl` (with `GOBIN` or `PATH` set appropriately).
70+
Or: `make install` / `go install ./cmd/agentctl` (honours `GOBIN` / `GOPATH/bin`; ensure that directory is on `PATH`).
7171

7272
### Create a project and run the loop
7373

@@ -123,15 +123,24 @@ Exit codes are summarized in **section 11.2** of [`docs/design_doc.md`](docs/des
123123

124124
## Development
125125

126-
```bash
127-
make fmt # go fmt ./...
128-
make vet # go vet ./...
129-
make test # go test ./... -race
130-
make test-coverage # coverage profile
131-
make build # bin/agentctl
132-
```
133-
134-
CI (`.github/workflows/ci.yml`) runs **Linux, macOS, and Windows** on Go **1.22.x**, plus **Go 1.23.x** on Linux, with **race** and **shuffle** enabled.
126+
**`make`** defaults to **`help`**, which lists targets; the table below mirrors the [`Makefile`](Makefile) (`##` comments and recipes).
127+
128+
| Target | What it does |
129+
|--------|----------------|
130+
| `help` | Show usage and target list (default goal) |
131+
| `all` | `fmt``vet``test``build` (handy before a push) |
132+
| `build` | `go build``bin/agentctl` |
133+
| `install` | `go install ./cmd/agentctl` (`-trimpath`; uses `GOBIN` / `GOPATH/bin`) |
134+
| `clean` | Remove `bin/` and `coverage.out` |
135+
| `fmt` | `go fmt ./...` |
136+
| `verify-fmt` | Fail if `gofmt -l` would list files (matches CI-style formatting check) |
137+
| `vet` | `go vet ./...` |
138+
| `test` | `go test ./... -race` |
139+
| `test-coverage` | Tests with `-coverprofile=coverage.out` and a one-line `go tool cover -func` summary |
140+
| `check` | `vet` + `test` only (no formatting writes) |
141+
| `ci` | `verify-fmt` + `vet` + `test` (no build) |
142+
143+
CI (`.github/workflows/ci.yml`) runs **Linux, macOS, and Windows** on Go **1.22.x**, plus **Go 1.23.x** on Linux, with **race** and **shuffle** enabled (workflow steps are defined in YAML, not via `make ci`).
135144

136145
### Updating CLI golden files
137146

0 commit comments

Comments
 (0)