LBRYCommunity/tracker
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity

README: update development section

Browse source 
Fixes #269.
This commit is contained in:
Jimmy Zelinskie 2017-01-28 16:02:14 -05:00
parent 8cf49aad2e
commit a5dab8ac0a
1 changed files with 36 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -57,16 +57,49 @@ By verifying the infohash, Quay can be sure that only their content is being sha
### Getting Started
In order to compile the project, the [latest stable version of Go] and a [working Go environment] are required.
#### Building from HEAD
In order to compile the project, the [latest stable version of Go] and knowledge of a [working Go environment] are required.
```sh
$ go get -t -u github.com/chihaya/chihaya
$ go install github.com/chihaya/chihaya/cmd/chihaya
$ mkdir chihaya
$ export GOPATH=$PWD/chihaya
$ go get -t -u github.com/chihaya/chihaya/...
$ $GOPATH/bin/chihaya --help
```
[latest stable version of Go]: https://golang.org/dl
[working Go environment]: https://golang.org/doc/code.html
#### Reproducible Builds
Reproducible builds are handled by using [glide] to vendor dependencies.
```sh
$ cd $GOPATH/src/github.com/chihaya/chihaya
$ glide install
$ go install github.com/chihaya/chihaya/...
$ $GOPATH/bin/chihaya --help
```
[glide]: https://glide.sh
#### Docker
Docker containers are available for [HEAD] and [stable] releases.
[HEAD]: https://quay.io/jzelinskie/chihaya-git
[stable]: https://quay.io/jzelinskie/chihaya
#### Testing
The following will run all tests and benchmarks.
Removing `-bench` will just run unit tests.
```sh
$ go test -bench $(glide novendor | grep -v contrib)
```
### Contributing
Long-term discussion and bug reports are maintained via [GitHub Issues].