From a54f6850c8e42b55573ce5777c242e6e23050a5c Mon Sep 17 00:00:00 2001 From: Arceliar Date: Wed, 24 Jan 2018 17:59:23 -0600 Subject: [PATCH] Update docs to mention cross compiling and Windows support --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index f260259e..257724dd 100644 --- a/README.md +++ b/README.md @@ -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. `./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. 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 To run the program, you'll need permission to create a `tun` device and configure it using `ip`.