Skip to content

Commit

Permalink
docs: Add note about GOPATH and pigeon missing
Browse files Browse the repository at this point in the history
Signed-off-by: Torin Sandall <torinsandall@gmail.com>
  • Loading branch information
tsandall committed Feb 22, 2019
1 parent a956d96 commit 0d15d53
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions docs/devel/DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
---
layout: docs
title: Development
section: references
sort_order: 100
---

## Development

OPA is written in the [Go](https://golang.org) programming language.
Expand All @@ -28,6 +21,19 @@ After cloning the repository, just run `make`. This will:
- Run all of the tests.
- Run all of the static analysis checks.

If `make` fails with `main.go:20: running "pigeon": exec: "pigeon":
executable file not found in $PATH` make sure that `$GOPATH/bin` is
in `$PATH`. If `$GOPATH` is undefined, it defaults to
`$HOME/go/bin`:

```
export PATH=$PATH:$GOPATH/bin
# OR
export PATH=$PATH:$HOME/go/bin
```

If the build was successful, a binary will be produced in the top directory (`opa_<OS>_<ARCH>`).

Verify the build was successful with `./opa_<OS>_<ARCH> run`.
Expand Down

0 comments on commit 0d15d53

Please sign in to comment.