Skip to content

Commit

Permalink
Minor Documentation and Makefile fixes (#89)
Browse files Browse the repository at this point in the history
* 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.
  • Loading branch information
sam-caldwell authored and rupa committed Nov 18, 2019
1 parent af7f55d commit 1c97f0d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
7 changes: 7 additions & 0 deletions GNUmakefile
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 1c97f0d

Please sign in to comment.