Update build instructions

// FREEBIE
pull/1/head
Michael Kirk 7 years ago
parent 99c982fbb2
commit 6a4c6915a2

@ -1,55 +1,85 @@
## Building # Building
1) Clone the repo to a working directory ## 1. Clone
2) [CocoaPods](http://cocoapods.org) is used to manage dependencies. Pods are setup easily and are distributed via a ruby gem. Follow the simple instructions on the website to setup. After setup, run the following command from the toplevel directory of Signal-iOS to download the dependencies for Signal-iOS: Clone the repo to a working directory
## 2. Depenencies
### tldr;
Build and configure dependencies.
```
make dependencies
```
### Dependency Details
We have a couple of dependency management tools. We us Carthage for
managing frameworks, but because some of our dependencies are not yet
framework compatible, we use Cocoapods to manage the remainder in a
static library.
2.1) [CocoaPods](http://cocoapods.org) is used to manage the dependencies in our static library. Pods are setup easily and are distributed via a ruby gem. Follow the simple instructions on the website to setup. After setup, run the following command from the toplevel directory of Signal-iOS to download the dependencies for Signal-iOS:
``` ```
pod install pod install
``` ```
If you are having build issues, first make sure your pods are up to date If you are having build issues, first make sure your pods are up to date
``` ```
pod update pod repo update
pod install pod install
``` ```
occasionally, CocoaPods itself will need to be updated. Do this with occasionally, CocoaPods itself will need to be updated. Do this with
``` ```
sudo gem update gem update cocoapods
pod repo update
pod install
``` ```
3) Some dependencies are added via carthage. However, our prebuilt WebRTC.framework also resides in the Carthage directory. 2.2) Framework dependencies are built and managed using [Carthage](https://github.com/Carthage/Carthage). Our prebuilt WebRTC.framework also resides in the Carthage/Build directory.
If you don't have carthage, here are the [install instructions](https://github.com/Carthage/Carthage#installing-carthage).
Once Carthage is installed, run:
Run:
``` ```
// DO NOT run: `carthage update` or `carthage checkout`. // DO NOT run: `carthage update` or `carthage checkout`.
git submodule update --init git submodule update --init
carthage build carthage build --platform iOS
``` ```
If you don't have carthage, here are install instructions: ## 3. XCode
```
https://github.com/Carthage/Carthage#installing-carthage
```
4) Open the `Signal.xcworkspace` in Xcode. Open the `Signal.xcworkspace` in Xcode.
``` ```
open Signal.xcworkspace open Signal.xcworkspace
``` ```
5) In the Signal target on the General tab, change the Team drop down to your own. On the Capabilities tab turn off Push Notifications and Data Protection. Only Background Modes should remain on. In the Signal target on the General tab, change the Team drop down to
your own. On the Capabilities tab turn off Push Notifications and Data
Protection. Only Background Modes should remain on.
6) Some of our build scripts, like running tests, expect your Derived Some of our build scripts, like running tests, expect your Derived
Data directory to be `$(PROJECT_DIR)/build`. In Xcode, go to `Preferences-> Locations`, Data directory to be `$(PROJECT_DIR)/build`. In Xcode, go to `Preferences-> Locations`,
and set the "Derived Data" dropdown to "Relative" and the text field and set the "Derived Data" dropdown to "Relative" and the text field
value to "build". value to "build".
7) Build and Run and you are ready to go! Build and Run and you are ready to go!
## Known issues ## Known issues
Features related to push notifications are known to be not working for third-party contributors since Apple's Push Notification service pushs will only work with Open Whisper Systems production code signing certificate. Features related to push notifications are known to be not working for third-party contributors since Apple's Push Notification service pushs will only work with Open Whisper Systems production code signing certificate.
If you have any other issues, please ask on the [community forum](https://whispersystems.discoursehosting.net/).
### Building WebRTC ### Building WebRTC
A prebuilt version of WebRTC.framework resides in our Carthage submodule (see above). A prebuilt version of WebRTC.framework resides in our Carthage submodule (see above).

Loading…
Cancel
Save