Skip to content

Commit

Permalink
README development improvements (#236)
Browse files Browse the repository at this point in the history
  • Loading branch information
NiallRees authored Jul 31, 2020
1 parent 92a5e27 commit 22361ef
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,21 @@ In-depth docs are available [on the Terraform registry](https://registry.terrafo

## Development

To do development you need Go installed, this repo cloned and that's about it. It has not been tested on Windows, so if you find problems let us know.
If you do not have Go installed:

1. Install Go `brew install golang`
2. Make a Go development directory wherever you like `mkdir go_projects`
3. Add the following config to your profile
```
export GOPATH=$HOME/../go_projects # edit with your go_projects dir
export PATH=$PATH:$GOPATH/bin
```
4. Fork this repo and clone it into `go_projects`
5. cd to `terraform-provider-snowflake` and install all the required packages with `make setup`
6. Finally install goimports with `(cd && go get golang.org/x/tools/cmd/goimports)`.
7. You should now be able to successfully run the tests with `make test`

It has not been tested on Windows, so if you find problems let us know.

If you want to build and test the provider locally there is a make target `make install-tf` that will build the provider binary and install it in a location that terraform can find.

Expand Down

0 comments on commit 22361ef

Please sign in to comment.