Skip to content

Commit

Permalink
update install information in README
Browse files Browse the repository at this point in the history 
this change updates the "Installation and usage" section of the readme
to contain the latest `go install` style installation, and removes the
language warning about running `go get`.
  • Loading branch information
@elmiko
elmiko committed Nov 8, 2022
1 parent 3990510 commit 00b29f0
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,10 @@ kind bootstraps each "node" with [kubeadm][kubeadm]. For more details see [the d

For a complete [install guide] see [the documentation here][install guide].

You can install kind with `GO111MODULE="on" go get sigs.k8s.io/kind@v0.17.0`.
You can install kind with `go install sigs.k8s.io/kind@v0.17.0`.

**NOTE**: please use the latest go to do this. KIND is developed with the latest stable go, see [`.go-version`](./.go-version) for the exact version we're using.

**NOTE**: `go get` should not be run from a Go [modules] enabled project directory,
as go get inside a modules enabled project updates dependencies / behaves differently. Try for example `cd $HOME` first.

This will put `kind` in `$(go env GOPATH)/bin`. If you encounter the error
`kind: command not found` after installation then you may need to either add that directory to your `$PATH` as
shown [here](https://golang.org/doc/code.html#GOPATH) or do a manual installation by cloning the repo and run
Expand Down

0 comments on commit 00b29f0

Please sign in to comment.