summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 888a403..dd9baac 100644
--- a/README.md
+++ b/README.md
@@ -18,3 +18,15 @@ AI coded it under human supervision, and a human developer reviewed the code.
* [Configuration guide](docs/configuration.md)
* [Usage examples](docs/usage-examples.md)
+
+## Build and tasks
+
+Hexai uses Mage for developer tasks. Install Mage, then run targets like build, dev, test, and install.
+
+- Install Mage: `go install github.com/magefile/mage@latest`
+- Build binaries: `mage build` (produces `hexai` and `hexai-lsp`)
+- Dev build (+ tests, vet, lint): `mage dev`
+- Run tests: `mage test`
+- Install binaries to `GOPATH/bin`: `mage install`
+
+Note: `mage lint` uses `golangci-lint`. Install via `mage devinstall` if needed.