Merge pull request #621 from moredip/point-to-vagrant-dev-tooling-in-README

Point to vagrant dev tooling in README and CONTRIBUTE
This commit is contained in:
Armon Dadgar 2014-12-03 11:44:25 -08:00
commit 938ed3e853
2 changed files with 9 additions and 5 deletions

View File

@ -50,7 +50,8 @@ it raises the chances we can quickly merge or address your contributions.
## Setting up Go to work on Terraform
If you have never worked with Go before, you will have to complete the
following steps in order to be able to compile and test Terraform.
following steps in order to be able to compile and test Terraform (or
use the Vagrantfile in this repo to stand up a dev VM).
1. Install Go. Make sure the Go version is at least Go 1.2. Terraform will not work with anything less than
Go 1.2. On a Mac, you can `brew install go` to install Go 1.2.

View File

@ -46,11 +46,14 @@ All documentation is available on the
## Developing Terraform
If you wish to work on Terraform itself or any of its built-in providers,
you'll first need [Go](http://www.golang.org) installed (version 1.2+ is
_required_). Make sure Go is properly installed, including setting up
a [GOPATH](http://golang.org/doc/code.html#GOPATH).
you'll first need [Go](http://www.golang.org) installed on your machine (version
1.2+ is _required_). Alternatively, you can use the Vagrantfile in the root of
this repo to stand up a virtual machine with the appropriate dev tooling
already set up for you.
Next, install the following software packages, which are needed for some dependencies:
For local dev first make sure Go is properly installed, including setting up
a [GOPATH](http://golang.org/doc/code.html#GOPATH). Next, install the following
software packages, which are needed for some dependencies:
- [Git](http://git-scm.com/)
- [Mercurial](http://mercurial.selenic.com/)