oxen-io
/
session-ios
mirror of https://github.com/oxen-io/session-ios.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Adding building instructions + TextSecure in README

This commit is contained in:
Frederic Jacobs 2015-01-04 00:09:56 +01:00
parent ffd68d30c5
commit 0d7de05a13
3 changed files with 27 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
BUILDING.md Normal file
View File

@ -0,0 +1,24 @@
## Building
1) Clone the repo to a working directory
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:
```
pod install
```
If you are having build issues, first make sure your pods are up to date
```
pod update
pod install
```
occasionally, CocoaPods itself will need to be updated. Do this with
```
sudo gem update
```
3) Open the `Signal.xcworkspace` in Xcode. Build and Run and you are ready to go!
## 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.

2
Pods

@ -1 +1 @@
Subproject commit f90d02274c5c103da0f13e6e8217b99fb5e1d4d2
Subproject commit dd570a162f44f9cc88575962b2b08fda698d9f8e

27
README.md
View File

@ -1,40 +1,17 @@
# Signal for iOS [![Build Status](https://travis-ci.org/WhisperSystems/Signal-iOS.svg?branch=master)](https://travis-ci.org/WhisperSystems/Signal-iOS)
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/WhisperSystems/Signal-iOS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Signal allows you to make private phone calls and we are working on bringing secure messaging to it soon.
Signal allows you to make private phone calls ([RedPhone protocol](https://github.com/WhisperSystems/RedPhone/wiki)) and private text messaging ([TextSecure protocol](https://github.com/WhisperSystems/TextSecure/wiki)).
[![Available on the AppStore](http://cl.ly/WouG/Download_on_the_App_Store_Badge_US-UK_135x40.svg)](https://itunes.apple.com/app/id874139669)
## Building
While you can build Signal from this repo it will not be possible to use it without your code being signed using the Whisper Systems certificate (which is only available to core devs). The reason for this is that the (currently) required push notifications can only be sent to apps which have been signed by the key owned by the sender. There is currently no workaround. If you want to use rather than study Signal then please download from the App Store.
1) Clone the repo to a working directory
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:
```
pod install
```
If you are having build issues, first make sure your pods are up to date
```
pod update
pod install
```
occasionally, CocoaPods itself will need to be updated. Do this with
```
sudo gem update
```
3) Open the `Signal.xcworkspace` in Xcode. Build and Run and you are ready to go!
## Translation
Help us translate Signal! The translation effort happens on [Transifex](https://www.transifex.com/projects/p/signal-ios/)
## Interoperability
Signal works with [RedPhone on Android](https://github.com/WhisperSystems/Redphone).
Signal works with [RedPhone](https://github.com/WhisperSystems/Redphone) and [TextSecure](https://github.com/WhisperSystems/TextSecure) on Android.
## Cryptography Notice