From f8145769a9c71572f08d89e457cdbad78541936c Mon Sep 17 00:00:00 2001 From: Igor Vuk Date: Wed, 24 Sep 2014 18:28:35 +0200 Subject: [PATCH] Add syntax highlighting to README.md --- README.md | 37 +++++++++++++++++++++++-------------- 1 file changed, 23 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 768653603..92fcfcd0f 100644 --- a/README.md +++ b/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 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`. 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 this exits with exit status 0, then everything is working! - $ make updatedeps - ... - $ make - ... +```sh +$ make updatedeps +... +$ make +... +``` To compile a development version of Terraform and the built-in plugins, run `make dev`. This will put Terraform binaries in the `bin` folder: - $ make dev - ... - $ bin/terraform - ... - +```sh +$ make dev +... +$ bin/terraform +... +``` If you're developing a specific package, you can run tests for just that package by specifying the `TEST` variable. For example below, only `terraform` package tests will be run. - $ make test TEST=./terraform - ... +```sh +$ make test TEST=./terraform +... +``` ### Acceptance Tests @@ -107,8 +114,10 @@ account for whatever provider you're testing. 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 provider is. The `TESTARGS` variable is recommended to filter down