Update readme

Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
This commit is contained in:
Jason A. Donenfeld 2018-11-03 07:21:54 +01:00
parent ec943587fa
commit 4bcfdfa08e
1 changed files with 28 additions and 8 deletions

View File

@ -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