From 9123fea1e8ca2d34691486f4cf66410036e489d2 Mon Sep 17 00:00:00 2001 From: Jimmi Dyson Date: Wed, 10 Apr 2024 14:48:33 +0100 Subject: [PATCH] docs: Update README --- README.md | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index bf5a69fc..a4729946 100644 --- a/README.md +++ b/README.md @@ -175,17 +175,10 @@ Install direnv: Hook direnv into your shell if you haven't already: . -### Configure global go mod cache - -By default `devenv` will use an isolated go mod cache for each project which is great from an isolation point of view, -but terrible for disk space (duplication!). To configure a global go mod cache, add the following after the `direnv` -integration above to your shell config file, adapting the path as appropriate: - -```bash -export GOMODCACHE=~/go/pkg/mod -``` - ## Building the CLI -Build the CLI using `make build-snapshot` that will output binary into -`dist/mindthegap_$(GOOS)_$(GOARCH)/mindthegap` and put it in `$PATH`. +`mindthegap` uses [`task`](https://taskfile.dev/) for running build tasks. `task` will be automatically available when +the devbox environment is correctly set up. + +Build the CLI using `task build:snapshot` that will output binary into +`./dist/mindthegap_$(GOOS)_$(GOARCH)/mindthegap`.