summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-09-24 22:30:20 +0300
committerPaul Buetow <paul@buetow.org>2025-09-24 22:30:20 +0300
commit16ce1d306f89f44974eb033056bc65c1be9a5f8a (patch)
tree5899c8f35cb43e2193457819d1c39290d8820520 /README.md
parent95997ba2eb4de80b02245bacbf15e881adafd73c (diff)
move from Taskfile to Magefile
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 14 insertions, 9 deletions
diff --git a/README.md b/README.md
index 82dbe16..971b6ad 100644
--- a/README.md
+++ b/README.md
@@ -35,20 +35,25 @@ git clone https://codeberg.org/snonux/gos.git
cd gos
```
-Build the binaries:
+Build and install the binaries:
```bash
-go build -o gos ./cmd/gos
-go build -o gosc ./cmd/gosc
-sudo mv gos ~/go/bin
-sudo mv gosc ~/go/bin
+mage install
```
-Or, if you want to use the `Taskfile`:
+### Mage targets
-```bash
-go-task install
-```
+This project uses Mage for automation. Here are some common commands:
+
+* `mage` or `mage build`: Build the `gos` and `gosc` binaries.
+* `mage install`: Build and install the binaries to `~/go/bin`.
+* `mage clean`: Remove the built binaries.
+* `mage test`: Run the tests.
+* `mage fuzz`: Run the fuzz tests.
+* `mage lint`: Run the linter.
+* `mage vet`: Run `go vet`.
+* `mage dev`: Run tests, vet, and lint, then build the binaries with the race detector.
+* `mage devInstall`: Install `gopls` and `golangci-lint`.
## Configuration