path: root/README.md
diff options
authorJason A. Donenfeld <Jason@zx2c4.com>2019-03-04 03:54:29 +0100
committerJason A. Donenfeld <Jason@zx2c4.com>2019-03-04 06:55:46 +0100
commit852975b9166b05a0906a0c274f879fc77c7d0803 (patch)
tree4a9d1f6d93ad537976a981d3b71e063760c43a9a /README.md
parentifaceconfig: remove split routes param (diff)
build: support windows
TDM is old and ugly, but musl.cc is having issues right now.
Diffstat (limited to '')
1 files changed, 11 insertions, 13 deletions
diff --git a/README.md b/README.md
index 9772c996..2795c484 100644
--- a/README.md
+++ b/README.md
@@ -4,28 +4,26 @@ Nothing to see here yet. Come back later.
### Requirements
- - [Go ≥1.12](https://www.golang.org)
- [Wintun](https://git.zx2c4.com/wintun)
-### Clone
+### Building on Windows
-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.
+The build script will take care of downloading (without verification) and installing Go 1.12 and Mingw.
-$ cd Projects
-$ git clone --recursive https://git.zx2c4.com/wireguard-windows
+C:\Projects> git clone https://git.zx2c4.com/wireguard-windows
+C:\Projects> cd wireguard-windows
+C:\Projects\wireguard-windows> build
-### Building
+### Building on Linux
-The use of cgo/mingw makes it slightly easier to compile from WSL. Here are instructions for [Ubuntu 18.04 from the Windows Store](https://www.microsoft.com/en-us/p/ubuntu-1804-lts/9n9tngvndl3q) on WSL:
+You must first have Go 1.12 and Mingw installed.
-$ sudo apt update
-$ sudo apt install mingw-w64 make
-$ curl https://dl.google.com/go/go1.12.linux-amd64.tar.gz | tar xzf -
-$ export PATH="$PWD/go/bin:$PATH"
-$ cd /mnt/c/Users/YourUsername/Projects/wireguard-windows
+$ sudo apt install mingw-w64 golang-go
+$ git clone https://git.zx2c4.com/wireguard-windows
+$ cd wireguard-windows
$ make
@@ -34,5 +32,5 @@ $ make
After you've built the application, run `wireguard.exe` to install the manager service and show the UI.
-$ ./wireguard.exe
+C:\Projects\wireguard-windows> wireguard