From 196b2fb1faefd878c11ec9e20746f85cc12967ae Mon Sep 17 00:00:00 2001 From: Jesse Squires Date: Tue, 24 Jul 2018 16:50:12 -0700 Subject: [PATCH] [Build] Update clone instructions Per discussion [here](https://community.signalusers.org/t/not-able-to-build-in-xcode-9-3-9-4/3498/12). Using `--recurse-submodules` will init and update all submodules, so you can do everything at once. I find this a bit nicer. (Also, it seems like it might be more reliable with GitHub forks?) I realize `make dependencies` runs `git submodule update --init`. It will just be a no-op if you clone this way. --- BUILDING.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index 7dfda72e7..04a7c2afc 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -1,20 +1,32 @@ # Building -We typically develop against the latest stable version of XCode. +We typically develop against the latest stable version of Xcode. -As of this writing, that's XCode 9.4 +As of this writing, that's Xcode 9.4. ## 1. Clone -Clone the repo to a working directory +Clone the repo to a working directory: ``` -git clone https:github.com/signalapp/Signal-iOS +git clone --recurse-submodules https:github.com/signalapp/Signal-iOS ``` Since we make use of submodules, you must use `git clone`, rather than downloading a prepared zip file from Github. +We recommend you fork the repo on GitHub, then clone your fork: + +``` +git clone --recurse-submodules https://github.com//Signal-iOS.git +``` + +You can then add the Signal repo to sync with upstream changes: + +``` +git remote add upstream https:github.com/signalapp/Signal-iOS +``` + ## 2. Dependencies To build and configure the libraries Signal uses, just run: @@ -73,7 +85,7 @@ A prebuilt version of WebRTC.framework resides in our Carthage submodule and should be installed by the above steps. However, if you'd like to build it from source, see: https://github.com/signalapp/signal-webrtc-ios -## 3. XCode +## 3. Xcode Open the `Signal.xcworkspace` in Xcode.