From 1c97f0d7aaea22e2355824caa50059c4a1146030 Mon Sep 17 00:00:00 2001 From: Sam Caldwell Date: Mon, 18 Nov 2019 09:43:10 -0600 Subject: [PATCH] Minor Documentation and Makefile fixes (#89) * wrap lines for long lines in README.md so it's easier to read with multiple tabs open (and more consistent with the rest of the file's formatting. * Add a 'clean' rule to make file so we can do 'make clean build' and know the old artifact is removed first. --- GNUmakefile | 7 +++++++ README.md | 7 +++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/GNUmakefile b/GNUmakefile index 2ecc4611..b6d219da 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -5,6 +5,13 @@ PKG_NAME=ns1 default: build +clean: + @if [[ -f $(GOPATH)/bin/terraform-provider-ns1 ]]; then \ + rm $(GOPATH)/bin/terraform-provider-ns1; \ + else \ + echo "nothing to clean."; \ + fi + build: fmtcheck go install diff --git a/README.md b/README.md index 7ee9bdc4..40773060 100644 --- a/README.md +++ b/README.md @@ -347,9 +347,12 @@ For each of those resources, these parameters are available at the top level of Developing The Provider --------------------------- -If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (version 1.11+ is *required*). You'll also need to correctly setup a [GOPATH](http://golang.org/doc/code.html#GOPATH), as well as adding `$GOPATH/bin` to your `$PATH`. +If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine +(version 1.11+ is *required*). You'll also need to correctly setup a [GOPATH](http://golang.org/doc/code.html#GOPATH), +as well as adding `$GOPATH/bin` to your `$PATH`. -To compile the provider, run `make build`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory. +To compile the provider, run `make build`. This will build the provider and put the provider binary in +the `$GOPATH/bin` directory. ```sh $ make bin