Merge pull request #320 from ivuk/syntax-highlighting-readme-md
Add syntax highlighting to README.md
This commit is contained in:
commit
f05b2411e9
37
README.md
37
README.md
|
@ -58,33 +58,40 @@ Next, install the following software packages, which are needed for some depende
|
||||||
Then, install [Gox](https://github.com/mitchellh/gox), which is used
|
Then, install [Gox](https://github.com/mitchellh/gox), which is used
|
||||||
as a compilation tool on top of Go:
|
as a compilation tool on top of Go:
|
||||||
|
|
||||||
$ go get -u github.com/mitchellh/gox
|
```sh
|
||||||
|
$ go get -u github.com/mitchellh/gox
|
||||||
|
```
|
||||||
|
|
||||||
Next, clone this repository into `$GOPATH/src/github.com/hashicorp/terraform`.
|
Next, clone this repository into `$GOPATH/src/github.com/hashicorp/terraform`.
|
||||||
Install the necessary dependencies by running `make updatedeps` and then just
|
Install the necessary dependencies by running `make updatedeps` and then just
|
||||||
type `make`. This will compile some more dependencies and then run the tests. If
|
type `make`. This will compile some more dependencies and then run the tests. If
|
||||||
this exits with exit status 0, then everything is working!
|
this exits with exit status 0, then everything is working!
|
||||||
|
|
||||||
$ make updatedeps
|
```sh
|
||||||
...
|
$ make updatedeps
|
||||||
$ make
|
...
|
||||||
...
|
$ make
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
To compile a development version of Terraform and the built-in plugins,
|
To compile a development version of Terraform and the built-in plugins,
|
||||||
run `make dev`. This will put Terraform binaries in the `bin` folder:
|
run `make dev`. This will put Terraform binaries in the `bin` folder:
|
||||||
|
|
||||||
$ make dev
|
```sh
|
||||||
...
|
$ make dev
|
||||||
$ bin/terraform
|
...
|
||||||
...
|
$ bin/terraform
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
If you're developing a specific package, you can run tests for just that
|
If you're developing a specific package, you can run tests for just that
|
||||||
package by specifying the `TEST` variable. For example below, only
|
package by specifying the `TEST` variable. For example below, only
|
||||||
`terraform` package tests will be run.
|
`terraform` package tests will be run.
|
||||||
|
|
||||||
$ make test TEST=./terraform
|
```sh
|
||||||
...
|
$ make test TEST=./terraform
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
### Acceptance Tests
|
### Acceptance Tests
|
||||||
|
|
||||||
|
@ -107,8 +114,10 @@ account for whatever provider you're testing.
|
||||||
|
|
||||||
To run the acceptance tests, invoke `make testacc`:
|
To run the acceptance tests, invoke `make testacc`:
|
||||||
|
|
||||||
$ make testacc TEST=./builtin/providers/aws TESTARGS='-run=VPC'
|
```sh
|
||||||
...
|
$ make testacc TEST=./builtin/providers/aws TESTARGS='-run=VPC'
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
The `TEST` variable is required, and you should specify the folder where
|
The `TEST` variable is required, and you should specify the folder where
|
||||||
the provider is. The `TESTARGS` variable is recommended to filter down
|
the provider is. The `TESTARGS` variable is recommended to filter down
|
||||||
|
|
Loading…
Reference in New Issue