README: describe the "make tools" target

This commit is contained in:
Dustin J. Mitchell 2018-07-03 12:33:31 -04:00 committed by Martin Atkins
parent 9441e78fb9
commit 78090fcccc
1 changed files with 5 additions and 1 deletions

View File

@ -41,10 +41,14 @@ This repository contains only Terraform core, which includes the command line in
For local development of Terraform core, first make sure Go is properly installed and that a For local development of Terraform core, first make sure Go is properly installed and that a
[GOPATH](http://golang.org/doc/code.html#GOPATH) has been set. You will also need to add `$GOPATH/bin` to your `$PATH`. [GOPATH](http://golang.org/doc/code.html#GOPATH) has been set. You will also need to add `$GOPATH/bin` to your `$PATH`.
Next, using [Git](https://git-scm.com/), clone this repository into `$GOPATH/src/github.com/hashicorp/terraform`. All the necessary dependencies are either vendored or automatically installed, so you just need to type `make`. This will compile the code and then run the tests. If this exits with exit status 0, then everything is working! Next, using [Git](https://git-scm.com/), clone this repository into `$GOPATH/src/github.com/hashicorp/terraform`.
You'll need to run `make tools` to install some required tools, then `make`. This will compile the code and then run the tests. If this exits with exit status 0, then everything is working!
You only need torun `make tools` once (or when the tools change).
```sh ```sh
$ cd "$GOPATH/src/github.com/hashicorp/terraform" $ cd "$GOPATH/src/github.com/hashicorp/terraform"
$ make tools
$ make $ make
``` ```