root
/
helm
mirror of https://github.com/helm/helm.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Fix the build section in the developer doc 

Signed-off-by: Martin Hickey <martin.hickey@ie.ibm.com>
This commit is contained in:
Martin Hickey 2019-06-13 09:24:50 +01:00
parent f109b1ba5c
commit b7a6ea321d
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/developers.md
View File

@ -15,22 +15,22 @@ Helm.
We use Make to build our programs. The simplest way to get started is: We use Make to build our programs. The simplest way to get started is:
```console ```console
$ make bootstrap build $ make
``` ```
NOTE: This will fail if not running from the path `$GOPATH/src/helm.sh/helm`. The 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 directory `helm.sh` should not be a symlink or `build` will not find the relevant
packages. packages.
This will build both Helm and the Helm library. `make bootstrap` will attempt to If required, this will first install dependencies, rebuild the `vendor/` tree, and
install certain tools if they are missing. 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 To run all the tests (without running the tests for `vendor/`), run
`make test`. `make test`.
To run Helm locally, you can run `bin/helm`. 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 ### Man pages