parent
8cf49aad2e
commit
a5dab8ac0a
1 changed files with 36 additions and 3 deletions
39
README.md
39
README.md
|
@ -57,16 +57,49 @@ By verifying the infohash, Quay can be sure that only their content is being sha
|
||||||
|
|
||||||
### Getting Started
|
### 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
|
```sh
|
||||||
$ go get -t -u github.com/chihaya/chihaya
|
$ mkdir chihaya
|
||||||
$ go install github.com/chihaya/chihaya/cmd/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
|
[latest stable version of Go]: https://golang.org/dl
|
||||||
[working Go environment]: https://golang.org/doc/code.html
|
[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
|
### Contributing
|
||||||
|
|
||||||
Long-term discussion and bug reports are maintained via [GitHub Issues].
|
Long-term discussion and bug reports are maintained via [GitHub Issues].
|
||||||
|
|
Loading…
Add table
Reference in a new issue