Skip to content

Commit

Permalink
Clarify the development process instructions a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
ldmberman committed Sep 16, 2015
1 parent 5c7d8ca commit c18b091
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,15 +177,16 @@ 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 <resource> <command>`.
* Install go vet: `go get code.google.com/p/go.tools/cmd/vet`.
* 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`.

0 comments on commit c18b091

Please sign in to comment.