]> git.ipfire.org Git - thirdparty/wireguard-apple.git/commitdiff
Update readme
authorJason A. Donenfeld <Jason@zx2c4.com>
Sat, 3 Nov 2018 06:21:54 +0000 (07:21 +0100)
committerJason A. Donenfeld <Jason@zx2c4.com>
Sat, 3 Nov 2018 06:25:43 +0000 (07:25 +0100)
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
README.md

index 8af490360ccf8a3a3b1ee4d9058d1cedb7951da4..2762fc367f65b17483a70454a95c0aae2e282c56 100644 (file)
--- 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