Skip to content

Add GOPATH tips to contributor docs #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zwass merged 1 commit into from
Nov 5, 2020
Merged

Add GOPATH tips to contributor docs #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions docs/development/building-the-code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,19 @@ To setup a working local development environment, you must install the following

* [Go](https://golang.org/dl/) (1.9 or greater)
* [Node.js](https://nodejs.org/en/download/current/) and [Yarn](https://yarnpkg.com/en/docs/install)
* [GNU Make](https://www.gnu.org/software/make/)
* [GNU Make](https://www.gnu.org/software/make/) (probably already installed if you're on macOS/Linux)
* [Docker](https://www.docker.com/products/overview#/install_the_platform)

If you're using MacOS or Linux, Make should be installed by default. If you are using Windows, you will need to install it separately.
> #### New to the Go language?
>
> After installing Go, your $GOPATH will probably need a little freshening up. To take care of this automatically every time a new terminal is opened, add this to your shell startup script (`~/.profile`):
> ```bash
> # Allow go-bindata and other Go stuff to work properly (e.g. for Fleet/osquery)
> # More info: https://golang.org/doc/gopath_code.html#GOPATH
> export PATH=$PATH:$(go env GOPATH)/bin
> ```

Once you have those minimum requirements, you will need to install Fleet's dependent libraries. To do this, run the following from the root of the repository:
Once you have those minimum requirements, you will need to install Fleet's dependencies. To do this, run the following from the root of the repository:

```
make deps
Expand Down