From 4bcfdfa08e797f627c52b3cf492413b132b2a635 Mon Sep 17 00:00:00 2001 From: "Jason A. Donenfeld" Date: Sat, 3 Nov 2018 07:21:54 +0100 Subject: Update readme Signed-off-by: Jason A. Donenfeld --- README.md | 36 ++++++++++++++++++++++++++++-------- 1 file changed, 28 insertions(+), 8 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 8af4903..2762fc3 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 -- cgit v1.2.3-59-g8ed1b