aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2018-11-03 07:21:54 +0100
committerJason A. Donenfeld <Jason@zx2c4.com>2018-11-03 07:25:43 +0100
commit4bcfdfa08e797f627c52b3cf492413b132b2a635 (patch)
tree124d62581b86a7dc9c7d7da85adb8e59124af411 /README.md
parentTunnelsManager: initialize observer on correct thread (diff)
downloadwireguard-apple-4bcfdfa08e797f627c52b3cf492413b132b2a635.tar.xz
wireguard-apple-4bcfdfa08e797f627c52b3cf492413b132b2a635.zip
Update readme
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
Diffstat (limited to '')
-rw-r--r--README.md36
1 files changed, 28 insertions, 8 deletions
diff --git a/README.md b/README.md
index 8af49036..2762fc36 100644
--- a/README.md
+++ b/README.md
@@ -5,16 +5,36 @@
# [WireGuard](https://www.wireguard.com/) for iOS
-## To get started...
+## Building
-Make sure you have Go available. A homebrew install will do. `brew install go`
+- Clone this repo:
-- Clone this repo.
- - `git clone https://git.zx2c4.com/wireguard-ios`
- - Init and update submodule: `git submodule init && git submodule update`
-- Prepare Xcode project
- - Run `pod install`
- - Open `WireGuard.xcworkspace`
+```
+$ git clone https://git.zx2c4.com/wireguard-ios
+$ cd wireguard-ios
+```
+
+- Init and update submodule:
+
+```
+$ git submodule init
+$ git submodule update
+```
+
+- Rename and populate developer team ID file:
+
+```
+$ cp WireGuard/WireGuard/Config/Developer.xcconfig.template WireGuard/WireGuard/Config/Developer.xcconfig
+$ vim WireGuard/WireGuard/Config/Developer.xcconfig
+```
+
+- Open project in XCode:
+
+```
+$ open ./WireGuard/WireGuard.xcodeproj
+```
+
+- Flip switches, press buttons, and make whirling noises until XCode builds it.
## MIT License