Skip to content

Commit

Permalink
Document that gnu utils are required in mac (#578)
Browse files Browse the repository at this point in the history
* Document that gnu utils  are required in mac

grep and sed are not part of coreutils package so we need to install
them aside

* Merge brew install commands into one
  • Loading branch information
naxhh authored Apr 2, 2020
1 parent 8ba73fd commit 368a3ec
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/CONTRIBUTOR_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,21 @@ git clone https://github.com/kubernetes-sigs/krew .
git remote set-url origin --push no_push # to avoid pushes
```

### Using macOS for development

The tools provided in the `hack` folder expect you to use GNU binaries, the easiest way to install them is to use brew

```bash
brew install coreutils grep gnu-sed
```
And remember to add them to your `$PATH` to make them your default binaries

```bash
export PATH=$(brew --prefix coreutils)/libexec/gnubin:$PATH
export PATH="$(brew --prefix grep)/libexec/gnubin:$PATH"
export PATH="$(brew --prefix gnu-sed)/libexec/gnubin:$PATH"
```

## Code style

Krew adheres to standard `golang` code formatting conventions, and also expects
Expand Down

0 comments on commit 368a3ec

Please sign in to comment.