Merge pull request #11 from neolit123/update-readme

README: modify the build step for binaries
kubernetes-retired · Jun 24, 2019 · 8639b13 · 8639b13
2 parents 25dac24 + a57ad94
commit 8639b13
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+capdctl
+capd-manager
+kind-test
diff --git a/README.md b/README.md
@@ -6,10 +6,16 @@ A sample is built and hosted at `gcr.io/kubernetes1-226021/capd-manager:latest`
 
 ### Building the binaries
 
-Requires go with go modules.
+Requires go 1.12+ with go modules.
 
-* `go build ./cmd/...`
-* `go build ./cmd/`
+```
+# required if `cluster-api-provider-docker` was cloned into $GOPATH
+export GO111MODULE=on
+# build the binaries
+go build ./cmd/capdctl
+go build ./cmd/capd-manager
+go build ./cmd/kind-test
+```
 
 ### Building the image