From 22361ef152bcbf0d432ee2c8467a24f58e8961a1 Mon Sep 17 00:00:00 2001 From: NiallRees Date: Fri, 31 Jul 2020 21:37:31 +0100 Subject: [PATCH] README development improvements (#236) --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fdf9db37c2..08d5c4266a 100644 --- a/README.md +++ b/README.md @@ -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.