Update docs to mention cross compiling and Windows support

This commit is contained in:
Arceliar 2018-01-24 17:59:23 -06:00
parent 83e0579ca8
commit a54f6850c8

View File

@ -17,9 +17,12 @@ You're encouraged to play with it, but I strongly advise against using it for an
2. Clone this repository. 2. Clone this repository.
2. `./build` 2. `./build`
Note that you can cross compile by specifying the `$GOOS` and `$GOARCH` environment variables.
The build script sets its own `$GOPATH`, so the build environment is self-contained. The build script sets its own `$GOPATH`, so the build environment is self-contained.
This code should work on Linux and macOS, but see the optional example below for a way to share connectivity with the rest of a network. This code should work on Linux and macOS, but see the optional example below for a way to share connectivity with the rest of a network.
It should also work on Windows 7 or later, but you will first need to install the OpenVPN NDIS 6 TAP driver.
## Running ## Running
To run the program, you'll need permission to create a `tun` device and configure it using `ip`. To run the program, you'll need permission to create a `tun` device and configure it using `ip`.