Files
kustomize/docs/macDevGuide.md
Jonathan Wong 563564a198 Add tree to necessary tools
I don't believe "tree" is under the branch of gnu tools, so it might be misleading to put it under "Install gnu tools." Should we leave it like this or change the title to "Install gnu/unix tools"
2019-11-12 12:37:40 -08:00

42 lines
732 B
Markdown

# Developing on Mac OS
## Setup your dev environment
First install the tools to build and run tests
### Install go 1.13
[Instructions](https://golang.org/doc/install)
Add `go` to your PATH
### Install kubeval
[Instructions](https://github.com/instrumenta/kubeval)
```sh
go get github.com/instrumenta/kubeval
```
Add `kubeval` to your PATH
### Install gnu tools
[Instructions](https://www.topbug.net/blog/2013/04/14/install-and-use-gnu-command-line-tools-in-mac-os-x/)
```sh
brew install coreutils wget gnu-sed tree
```
Add the new tools to your PATH
## Run the pre-commit tests
Run the `pre-commit` target to verify your install
```sh
make pre-commit
```
This will run the go tests, as well as documentation tests.