diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 35af867..36b6e7e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ contribution. See the [DCO](DCO) file for details. ## Getting Started -You'll need Go 1.8 or newer installed. +You'll need Go 1.10 or newer installed. 1. [Fork this repo](https://github.com/sourcegraph/checkup). This makes a copy of the code you can write to. 2. If you don't already have this repo (sourcegraph/checkup.git) repo on your computer, get it with `go get github.com/sourcegraph/checkup/cmd/checkup`. diff --git a/README.md b/README.md index e4d0567..b96e489 100644 --- a/README.md +++ b/README.md @@ -451,6 +451,24 @@ Uh oh, having some fires? 🔥 You can create a type that implements `checkup.No You can implement your own Checker and Storage types. If it's general enough, feel free to submit a pull request so others can use it too! +### Building Locally + +Requires Go v1.10 or newer. + +```bash +git clone git@github.com:sourcegraph/checkup.git +cd checkup/cmd/checkup/ + +# Install dependencies +go get -v -d + +# Build binary +go build -v -ldflags '-s' -o ../../checkup + +# Run tests +go test -race ../../ +``` + ### Building with Docker Linux binary: