From 2d8f0259cde882619ca83413af8a86eee1e9d4e8 Mon Sep 17 00:00:00 2001 From: Joerg Schad Date: Fri, 15 Feb 2019 21:18:43 -0800 Subject: [PATCH] Add local build steps to CONTRIBUTING. (#124) * Provide local build instructions in CONTRIBUTING> * Remove kubebuilder dep. * Add docker build steps. --- CONTRIBUTING.md | 17 ++++++++++++++++- README.md | 1 - 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c535dca70..fd451c99d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,22 @@ Please see [https://git.k8s.io/community/CLA.md](https://git.k8s.io/community/CL ## How to build Kudo locally -TBD +### Pre-requisites + +Before you get started: + +- Install Go `1.11` or later +- Latest version of `dep` +- [Install Kubebuilder](https://book.kubebuilder.io/getting_started/installation_and_setup.html) +- Kubernetes Cluster `1.12` or later (e.g. [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/)) +- [Configure kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) + +### Build Instructions + +- Get KUDO repo: `go get github.com/kudobuilder/kudo/` +- `cd $GOPATH/src/github.com/kudobuilder/kudo` +- `make all` to build project +- [optionally] `make docker-build` to build docker images and `make docker-push` to push images ## Community, Discussion, and Support diff --git a/README.md b/README.md index b6a68a606..fcfbe04ce 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,6 @@ Before you get started: - Install Go `1.11` or later - Latest version of `dep` -- [Install Kubebuilder](https://book.kubebuilder.io/getting_started/installation_and_setup.html) - Kubernetes Cluster `1.12` or later (e.g. [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/)) - [Configure kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)