Skip to content

Commit

Permalink
Doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
dougm committed Jun 6, 2017
1 parent 5aef608 commit 9c5f63e
Show file tree
Hide file tree
Showing 36 changed files with 495 additions and 65 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,16 @@ git remote add $USER [email protected]:$USER/govmomi.git
git fetch $USER
```

## Installing from source

Compile the govmomi libraries and install govc using:

``` shell
go install -v github.com/vmware/govmomi/govc
```

Note that **govc/build.sh** is only used for building release binaries.

## Contribution flow

This is a rough outline of what a contributor's workflow looks like:
Expand Down
9 changes: 8 additions & 1 deletion govc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ chmod +x /usr/local/bin/govc
You can install the latest govc version from source if you have the Go toolchain installed.

```sh
go get github.com/vmware/govmomi/govc
go get -u github.com/vmware/govmomi/govc
```

(make sure `$GOPATH/bin` is in your `PATH`)
Expand Down Expand Up @@ -109,6 +109,13 @@ to set defaults:

* `GOVC_VIM_VERSION`: Vim version defaults to `6.0`

## Platform specific notes

### MSYS2 (Windows)

Inventory path arguments with a leading '/' are subject
to [Posix path conversion](http://www.mingw.org/wiki/Posix_path_conversion).

## Examples

Several examples are embedded in the govc command [help](USAGE.md)
Expand Down
Loading

0 comments on commit 9c5f63e

Please sign in to comment.