Skip to content

Commit 6cb29ea

Browse files
author
Jim Crowley
committed
Updating build instructions to adhere to the terraform provider standards
1 parent 5c01d18 commit 6cb29ea

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,13 @@ Follow the instructions for your distribution:
5858

5959
## Building from source
6060

61-
Before building, you will need the following
61+
### Requirements
62+
63+
- [Terraform](https://www.terraform.io/downloads.html) 0.11.x
64+
- [Go](https://golang.org/doc/install) (to build the provider plugin)
65+
- [libvirt](https://libvirt.org/downloads.html) 1.2.14 or newer development headers
66+
- `cgo` is required by the [libvirt-go](https://github.com/libvirt/libvirt-go) package. `export CGO_ENABLED="1"`
6267

63-
* libvirt 1.2.14 or newer development headers
64-
* latest [golang](https://golang.org/dl/) version
65-
* `cgo` is required by the [libvirt-go](https://github.com/libvirt/libvirt-go) package. `export CGO_ENABLED="1"`
6668

6769
This project uses [go modules](https://github.com/golang/go/wiki/Modules) to vendor all its
6870
dependencies.
@@ -74,8 +76,18 @@ takes advantage of features available only inside of the latest stable release.
7476

7577
You need also need libvirt-dev(el) package installed.
7678

79+
###Building The Provider
80+
81+
Clone repository to: `$GOPATH/src/github.com/dmacvicar/terraform-provider-libvirt`
82+
83+
```console
84+
mkdir -p $GOPATH/src/github.com/dmacvicar; cd $GOPATH/src/github.com/dmacvicar
85+
git clone [email protected]:dmacvicar/terraform-provider-libvirt
86+
```
87+
88+
Enter the provider directory and build the provider
89+
7790
```console
78-
go get github.com/dmacvicar/terraform-provider-libvirt
7991
cd $GOPATH/src/github.com/dmacvicar/terraform-provider-libvirt
8092
make install
8193
```

0 commit comments

Comments
 (0)