Skip to content

Commit 7f08a90

Browse files
author
Yongkun Anfernee Gui
committed
Update README
1 parent b8421e1 commit 7f08a90

File tree

1 file changed

+37
-2
lines changed

1 file changed

+37
-2
lines changed

README.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,47 @@
22

33
This is a docker machine driver for VMware Fusion and Workstation.
44

5-
## Build
5+
## How to consume this driver
6+
7+
### Prerequisite
8+
Make sure you have VMware Workstation 14 (Windows/Linux) or VMware Fusion 10 (MacOS)
9+
installed on your machine. Earlier versions of Workstation/Fusion might still work
10+
with this driver, but it's not officially supported.
11+
12+
### Install
13+
For MacOS and Linux, make sure `$GOPATH/bin` is part of your `$PATH` for MacOS and Linux.
14+
For Windows, make sure `%GOPATH%\bin` is included in `%PATH%`.
15+
16+
Run the following command:
17+
18+
```shell
19+
go get -u github.com/machine-drivers/docker-machine-driver-vmware
20+
```
21+
22+
if the `PATH` is correctly setup, you will see this if you run the command
23+
24+
```shell
25+
$ docker-machine-driver-vmware
26+
This is a Docker Machine plugin binary.
27+
Plugin binaries are not intended to be invoked directly.
28+
Please use this plugin through the main 'docker-machine' binary.
29+
(API version: 1)
30+
```
31+
32+
### Usage
33+
The driver can be consumed by `docker-machine`, or potentially other tools that are
34+
compatible to docker machine drivers like `minikube` (not supported yet). For
35+
`docker-machine`, create a docker machine is simply a command like this:
636

737
```shell
8-
make build
38+
$ docker-machine create --driver=vmware default
939
```
1040

41+
## Difference between driver vmwarefusion
42+
Docker machine has a builtin driver called `vmwarefusion`. The main difference between
43+
those drivers is that `vmware` also works on VMware Workstation, while `vmwarefusion` only
44+
works on VMware Fusion.
45+
1146
## License
1247

1348
It's under the Apache 2 license.

0 commit comments

Comments
 (0)