From c18b091a4e40f5beb5508e71dc00c43613e6f34a Mon Sep 17 00:00:00 2001 From: Lev Berman Date: Wed, 16 Sep 2015 17:35:29 +0300 Subject: [PATCH] Clarify the development process instructions a bit --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b56676a..12c2218 100644 --- a/README.md +++ b/README.md @@ -177,9 +177,12 @@ The documentation of the underlying HTTP API can be found [here](https://www.ctl ## The Development Process +The development is supposed to happen on Unix/Linux/Mac systems. Some of the +instructions below may not work properly on Windows. + * [Install Go](https://golang.org/). * Install Godep: `go get github.com/tools/godep`. -* Clone this repo (you do not have to use `go get`). +* Clone this repo (do **not** use `go get`). * [Ensure your $GOPATH is set correctly](http://golang.org/cmd/go/#hdr-GOPATH_environment_variable). * Install dependencies with Godep: enter the repo's root and `godep restore`. * Use the dev script to run commands: `./dev `. @@ -187,5 +190,3 @@ The documentation of the underlying HTTP API can be found [here](https://www.ctl * Before commit check that `gofmt -d=true ./..` and `go vet ./...` do not produce any output (except for that coming from `Godeps/_workspace` - ignore it) and check that all tests pass via `./run_tests`. If you want to make an executable, simply run `./build`. The binary will appear in the `./out` folder. - -If you want bash autocomplete to work, you have to use the binary generated by the `./build` command. To turn autocomplete on either source `autocomplete/bash_autocomplete` or install it by running `./install_autocompletion`.