diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..dadee93d --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# [WireGuard](https://www.wireguard.com/) for Windows + +Nothing to see here yet. Come back later. + +### Requirements + + - [Go](https://www.golang.org) 1.11 + - [rsrc tool](https://github.com/akavel/rsrc) + - [Wintun](https://git.zx2c4.com/wintun) + + +### Clone + +This has a few submodules at the moment, so you'll need to clone recursively. While building (below) uses WSL, it's recommended that you still clone into Windows per usual. + +``` +$ cd Projects +$ git clone --recursive https://git.zx2c4.com/wireguard-windows +``` + +### Building + +Currently a mess while we transition a few things, so you'll actually need to use WSL. Here are instructions for the latest Ubuntu from the Windows Store on WSL: + +``` +$ sudo add-apt-repository ppa:longsleep/golang-backports +$ sudo apt update +$ sudo apt install mingw-w64 make golang-go +$ mkdir "$HOME/.go" +$ export GOPATH="$HOME/.go" +$ go get github.com/akavel/rsrc +$ cd /mnt/c/Users/YourUsername/Projects/wireguard-windows +$ make +``` + +### Running + +After you've built the application, run `wireguard.exe` to install the manager service and show the UI. + +``` +$ ./wireguard.exe +``` |