aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2019-05-29 13:53:49 +0200
committerJason A. Donenfeld <Jason@zx2c4.com>2019-05-29 14:05:24 +0200
commit4c696ba4bb14dac870f30976d78b30a5db557155 (patch)
tree55cb590e88534e07228d29b0aa39e30127799651
parenttunnel: allow for disabled ipv6 (diff)
downloadwireguard-windows-4c696ba4bb14dac870f30976d78b30a5db557155.tar.xz
wireguard-windows-4c696ba4bb14dac870f30976d78b30a5db557155.zip
README: document wg(8) building
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 43d11af9..353c392d 100644
--- a/README.md
+++ b/README.md
@@ -60,3 +60,16 @@ You can deploy the 64-bit build to an SSH host specified by the `DEPLOYMENT_HOST
```
$ make deploy
```
+
+### [`wg(8)`](https://git.zx2c4.com/WireGuard/about/src/tools/man/wg.8) Support for Windows
+
+The command line utility [`wg(8)`](https://git.zx2c4.com/WireGuard/about/src/tools/man/wg.8) works well on Windows. Being a Unix-centric project, it compiles with a Makefile and MingW:
+
+```
+$ git clone https://git.zx2c4.com/WireGuard
+$ cd WireGuard/src/tools
+$ PLATFORM=windows make
+$ stat wg.exe
+```
+
+It interacts with WireGuard instances run by the main WireGuard for Windows program.