Prefix example app with $GOPATH env var (#79)

Instead of using `cd` to change to the package directory, prepend the examples commands with `$GOPATH`, which will make the commands easier to follow for anyone unfamiliar with Go. It's easy to miss the 'cd' instruction above.
This commit is contained in:
Matt Bostock 2017-02-08 02:42:29 +00:00 committed by Aren Patel
parent ec041eb56b
commit 40fe9896b3
1 changed files with 2 additions and 3 deletions

View File

@ -87,12 +87,11 @@ To run,
* Make sure you have go installed * Make sure you have go installed
* Create the following directories or similar: `~/go` * Create the following directories or similar: `~/go`
* `cd` there
* Set `GOPATH` to `PWD` in your shell session, `export GOPATH=$PWD` * Set `GOPATH` to `PWD` in your shell session, `export GOPATH=$PWD`
* `go get github.com/google/jsonapi`. (Append `-u` after `get` if you * `go get github.com/google/jsonapi`. (Append `-u` after `get` if you
are updating.) are updating.)
* `go run src/github.com/google/jsonapi/examples/app.go` or `cd * `go run $GOPATH/src/github.com/google/jsonapi/examples/app.go` or `cd
src/github.com/google/jsonapi/examples && go run app.go` $GOPATH/src/github.com/google/jsonapi/examples && go run app.go`
## `jsonapi` Tag Reference ## `jsonapi` Tag Reference