Merge pull request #62 from dhellmann/document-dev-setup

document dev environment setup
metal3-io · Apr 22, 2019 · 87855e9 · 87855e9
2 parents 92584dd + 0ea1caf
commit 87855e9
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -8,5 +8,6 @@ For more information about this actuator and related repositories, see
 
 ## Development Environment
 
+* [Setting up for tests](docs/dev/setup.md)
 * Using [Minikube](docs/dev/minikube.md)
 * Using [OpenShift 4](docs/dev/openshift.md)
diff --git a/docs/dev/setup.md b/docs/dev/setup.md
@@ -0,0 +1,19 @@
+# Setting up a development environment
+
+The cluster-api requires two external tools for running the tests
+during development.
+
+## Install kustomize
+
+```bash
+eval $(go env)
+export GOPATH
+./tools/install_kustomize.sh
+```
+
+## Install kubebuilder
+
+```bash
+./tools/install_kubebuilder.sh
+sudo mv kubebuilder /usr/local
+```