diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..78052d6 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# A Go example + +You'll need `go` 1.23 at least. + +There's a [`Makefile`](Makefile), so you can do: + + $ make clean + $ make test + $ make + $ make run + +If you run: + + go install golang.org/x/tools/cmd/goimports@latest + go install github.com/daixiang0/gci@latest + go install mvdan.cc/gofumpt@latest + +then you can do `make fmt` to format all the source files. + +If you `go install +github.com/golangci/golangci-lint/cmd/golangci-lint@latest`, you can +also do `make lint` to get a linting / critique of all the source +files (`lint` runs `fmt` first, so you need to have installed the +packages above as well). + +Note that the `Makefile` is *for development*, it's not used on +production machines. |