Skip to content

Commit

Permalink
Merge pull request #13 from maxthomas/clarify-readme
Browse files Browse the repository at this point in the history
Add section in README.md about how to build an executable
  • Loading branch information
ryanleary authored Nov 22, 2016
2 parents 74a1ca0 + a2c6f07 commit b5d2666
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,20 @@ To start, go get the versioned repository::
go get gopkg.in/qntfy/kazaam.v1
```

### Using as an executable program

If you want to create an executable binary from this project, follow
these steps (you'll need `go` installed and `$GOPATH` set):

``` shell
go get gopkg.in/qntfy/kazaam.v1
cd $GOPATH/src/gopkg.in/qntfy.kazaam.v1/kazaam
go install
```

This will create an executable in `$GOPATH/bin` like you
would expect from the normal `go` build behavior.

### Examples

See [godoc examples](https://godoc.org/pkg/gopkg.in/qntfy/kazaam.v1/#pkg-examples).

0 comments on commit b5d2666

Please sign in to comment.