ThePain/Swiftgram
1
0
Fork 0
mirror of https://github.com/Swiftgram/Telegram-iOS.git synced 2025-06-16 05:55:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add installation documentation improvements

Browse Source 
Still work in progress
This commit is contained in:
Andreas Linde 2012-08-01 19:18:54 +02:00
parent bb92accaf2
commit 3f529f8c2e
1 changed files with 46 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
README.md
View File

@ -30,41 +30,70 @@ We propose the following method to set version numbers in your beta versions:
* "Bundle Version" should contain a sequential build number, e.g. 1, 2, 3.
* "Bundle Version String, short" should contain the target official version number, e.g. 1.0.
## Download & Extract
## Installation with binary distribution
1. Download the latest [HockeySDK-iOS](https://github.com/bitstadium/HockeySDK-iOS/downloads).
2. Unzip the file. A new folder HockeySDK-iOS is created.
### Download & Extract
1. Download the latest [HockeySDK-iOS](https://github.com/bitstadium/HockeySDK-iOS/downloads) framework.
2. Unzip the file. A new folder `HockeySDK-iOS` is created.
3. Move the folder into your project directory. We usually put 3rd-party code into a subdirectory named `Vendor`, so we move the directory into it.
## Integrate into Xcode
### Integrate into Xcode
1. Drag & drop the `HockeySDK-iOS` folder from your project directory to your Xcode project.
2. Similar to above, our projects have a group `Vendor`, so we drop it there.
3. Select `Create groups for any added folders` and set the checkmark for your target. Then click `Finish`.
## Add Frameworks
## Installation as Git Submodule
1. Select your project in the Project Navigator.
### Adding the Submodule
1. Open a Terminal window
2. Change to your projects directory `cd /path/to/MyProject'
3. If this is a new project, initialize Git: `git init`
4. Add the submodule: `git submodule add git://github.com/BitStadium/HockeySDK-iOS.git`
### Add HockeySDK to your project
1. Find the `HockeySDK.xcodeproj` file inside of the cloned HockeySDK-iOS project directory.
2. Drag & Drop it into the `Project Navigator` (⌘+1).
3. Select your project in the `Project Navigator` (⌘+1).
4. Select your target.
5. Select the tab `Build Phases`.
6. Expand `Target Dependencies`.
7. Add the following dependencies:
* HockeySDKLib
* HockeySDKResources
8. Expand `Link Binary With Libraries`.
9. Add `libHockeySDK.a`
9. Drag & Drop `CrashReporter.framework` from the `Frameworks` folder in `HockeySDK.xcodeproj`
10. Expand `Copy Bundle Resources`.
11. Drag & Drop `HockeySDKResources.bundle` from the `Products` folder in `HockeySDK.xcodeproj`
## Finish configuring your target
1. Select your project in the `Project Navigator` (⌘+1).
2. Select your target.
3. Select the tab `Build Phases`.
4. Expand `Link Binary With Libraries`.
5. You need all of the following frameworks:
* CoreGraphics.framework
* CrashReporter.framework
* CoreGraphics.framework
* Foundation.framework
* QuartzCore.framework
* SystemConfiguration.framework
* UIKit.framework
* UIKit.framework
6. If one of the frameworks is missing, then click the + button, search the framework and confirm with the `Add` button.
7. HockeySDK-iOS also needs a JSON library. If you target iOS 5, you can use the built-in `NSJSONSerialization` classes. If your deployment target is iOS 3.x or 4.x, please include one of the following libraries:
7. Select `Build Settings`
8. Search for `Other Linker Flags`
9. Double click on the build Setting titled Other Linker Flags.
10. Add `-ObjC`
11. Hit `Done`.
12. HockeySDK-iOS also needs a JSON library. If you deployment target iOS >= 5, everything is set. If your deployment target is iOS 4.x, please include one of the following libraries:
* [JSONKit](https://github.com/johnezang/JSONKit)
* [SBJSON](https://github.com/stig/json-framework)
* [YAJL](https://github.com/gabriel/yajl-objc)
* https://github.com/johnezang/JSONKit
* https://github.com/stig/json-framework
* https://github.com/gabriel/yajl-objc
## Setup HockeySDK-iOS
## Setup HockeySDK
1. Open your `AppDelegate.m` file.
2. Add the following line at the top of the file below your own #import statements:<pre><code>#import "HockeySDK.h"</code></pre>