From b7a6ea321d66726a3836b6e015687e4076995db6 Mon Sep 17 00:00:00 2001 From: Martin Hickey Date: Thu, 13 Jun 2019 09:24:50 +0100 Subject: [PATCH] Fix the build section in the developer doc Signed-off-by: Martin Hickey --- docs/developers.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/developers.md b/docs/developers.md index 47ce2132a..a520a8266 100644 --- a/docs/developers.md +++ b/docs/developers.md @@ -15,22 +15,22 @@ Helm. We use Make to build our programs. The simplest way to get started is: ```console -$ make bootstrap build +$ make ``` NOTE: This will fail if not running from the path `$GOPATH/src/helm.sh/helm`. The directory `helm.sh` should not be a symlink or `build` will not find the relevant packages. -This will build both Helm and the Helm library. `make bootstrap` will attempt to -install certain tools if they are missing. +If required, this will first install dependencies, rebuild the `vendor/` tree, and +validate configuration. It will then compile `helm` and place it in `bin/helm`. To run all the tests (without running the tests for `vendor/`), run `make test`. To run Helm locally, you can run `bin/helm`. -- Helm is known to run on macOS and most Linuxes, including Alpine. +- Helm is known to run on macOS and most Linux distributions, including Alpine. ### Man pages