Improve installation documentation and screenshots
@ -35,39 +35,47 @@ This document contains the following sections:
|
|||||||
3. Select `Create groups for any added folders` and set the checkmark for your target. Then click `Finish`.
|
3. Select `Create groups for any added folders` and set the checkmark for your target. Then click `Finish`.
|
||||||
4. Select your project in the `Project Navigator` (⌘+1).
|
4. Select your project in the `Project Navigator` (⌘+1).
|
||||||
5. Select your target.
|
5. Select your target.
|
||||||
6. Select the tab `Build Phases`.
|
6. Select the tab `Summary`.
|
||||||
7. Expand `Link Binary With Libraries`.
|
7. Expand `Link Binary With Libraries`.
|
||||||
8. You need all of the following frameworks:
|
8. The following entries should be present:
|
||||||
|
* `CrashReporter.framework`
|
||||||
|
* `HockeySDK.framework`
|
||||||
* `CoreGraphics.framework`
|
* `CoreGraphics.framework`
|
||||||
* `Foundation.framework`
|
* `Foundation.framework`
|
||||||
* `QuartzCore.framework`
|
* `QuartzCore.framework`
|
||||||
* `SystemConfiguration.framework`
|
* `SystemConfiguration.framework`
|
||||||
* `UIKit.framework`
|
* `UIKit.framework`
|
||||||
|
|
||||||

|
<img src="XcodeFrameworks1_normal.png"/>
|
||||||
|
|
||||||
9. If one of the frameworks is missing, then click the + button, search the framework and confirm with the `Add` button.
|
9. If one of the frameworks is missing, then click the + button, search the framework and confirm with the `Add` button.
|
||||||
10. Select `Build Settings`
|
10. Select `Build Phases`
|
||||||
11. Search for `Other Linker Flags`
|
11. The following entries should be present:
|
||||||
12. Double click on the build Setting titled Other Linker Flags.
|
* `HockeySDKResources.bundle`
|
||||||
13. Add `-ObjC`
|
|
||||||
|
|
||||||

|
<img src="XcodeCopyBundle1_normal.png"/>
|
||||||
|
|
||||||
14. Hit `Done`.
|
12. Select `Build Settings`
|
||||||
15. Search for `preprocessor macros`
|
13. Search for `Other Linker Flags`
|
||||||
|
14. Double click on the build Setting titled Other Linker Flags.
|
||||||
|
15. Add `-ObjC`
|
||||||
|
|
||||||

|
<img src="XcodeOtherLinkerFlags_normal.png"/>
|
||||||
|
|
||||||
16. Select the top-most line and double-click the value field.
|
16. Hit `Done`.
|
||||||
17. Click the + button.
|
17. Search for `preprocessor macros`
|
||||||
18. Enter the following string into the input field and finish with "Done".<pre><code>CONFIGURATION_$(CONFIGURATION)</code></pre>
|
|
||||||
|
|
||||||

|
<img src="XcodeMacros1_normal.png"/>
|
||||||
|
|
||||||
|
18. Select the top-most line and double-click the value field.
|
||||||
|
19. Click the + button.
|
||||||
|
20. Enter the following string into the input field and finish with "Done".<pre><code>CONFIGURATION_$(CONFIGURATION)</code></pre>
|
||||||
|
|
||||||
|
<img src="XcodeMacros2_normal.png"/>
|
||||||
|
|
||||||
Now you can use `#if defined (CONFIGURATION_ABCDEF)` directives in your code, where `ABCDEF` is the actual name of **YOUR** build configuration.
|
Now you can use `#if defined (CONFIGURATION_ABCDEF)` directives in your code, where `ABCDEF` is the actual name of **YOUR** build configuration.
|
||||||
|
|
||||||
19. 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:
|
21. 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)
|
* [JSONKit](https://github.com/johnezang/JSONKit)
|
||||||
* [SBJSON](https://github.com/stig/json-framework)
|
* [SBJSON](https://github.com/stig/json-framework)
|
||||||
* [YAJL](https://github.com/gabriel/yajl-objc)
|
* [YAJL](https://github.com/gabriel/yajl-objc)
|
||||||
@ -88,56 +96,58 @@ This document contains the following sections:
|
|||||||
1. Find the `HockeySDK.xcodeproj` file inside of the cloned HockeySDK-iOS project directory.
|
1. Find the `HockeySDK.xcodeproj` file inside of the cloned HockeySDK-iOS project directory.
|
||||||
2. Drag & Drop it into the `Project Navigator` (⌘+1).
|
2. Drag & Drop it into the `Project Navigator` (⌘+1).
|
||||||
3. Select your project in the `Project Navigator` (⌘+1).
|
3. Select your project in the `Project Navigator` (⌘+1).
|
||||||
4. Select your target.
|
4. Select your target.5.
|
||||||
5. Select the tab `Build Phases`.
|
5. Select the tab `Build Phases`.
|
||||||
6. Expand `Target Dependencies`.
|
6. Expand `Target Dependencies`.
|
||||||
7. Add the following dependencies:
|
7. Add the following dependencies:
|
||||||
* `HockeySDKLib`
|
* `HockeySDKLib`
|
||||||
* `HockeySDKResources`
|
* `HockeySDKResources`
|
||||||
|
|
||||||

|
<img src="XcodeTargetDependencies_normal.png"/>
|
||||||
|
|
||||||
8. Expand `Link Binary With Libraries`.
|
8. Expand `Link Binary With Libraries`.
|
||||||
9. Add `libHockeySDK.a`
|
9. Add `libHockeySDK.a`
|
||||||
|
|
||||||

|
<img src="XcodeLinkBinariesLib_normal.png"/>
|
||||||
|
|
||||||
10. Drag & Drop `CrashReporter.framework` from the `Frameworks` folder in `HockeySDK.xcodeproj`
|
10. Drag & Drop `CrashReporter.framework` from the `Frameworks` folder in `HockeySDK.xcodeproj`
|
||||||
|
|
||||||

|
<img src="XcodeLinkBinariesPLCrashReporter_normal.png"/>
|
||||||
|
|
||||||
11. You also need all of the following frameworks:
|
11. The following entries should be present:
|
||||||
|
* `CrashReporter.framework`
|
||||||
|
* `libHockeySDK.a`
|
||||||
* `CoreGraphics.framework`
|
* `CoreGraphics.framework`
|
||||||
* `Foundation.framework`
|
* `Foundation.framework`
|
||||||
* `QuartzCore.framework`
|
* `QuartzCore.framework`
|
||||||
* `SystemConfiguration.framework`
|
* `SystemConfiguration.framework`
|
||||||
* `UIKit.framework`
|
* `UIKit.framework`
|
||||||
|
|
||||||

|
<img src="XcodeFrameworks2_normal.png"/>
|
||||||
|
|
||||||
12. Expand `Copy Bundle Resources`.
|
12. Expand `Copy Bundle Resources`.
|
||||||
13. Drag & Drop `HockeySDKResources.bundle` from the `Products` folder in `HockeySDK.xcodeproj`
|
13. Drag & Drop `HockeySDKResources.bundle` from the `Products` folder in `HockeySDK.xcodeproj`
|
||||||
14. Select `Build Settings`
|
14. Select `Build Settings`
|
||||||
15. In `Header Search Paths`, add a path to `$(SRCROOT)\Vendor\HockeyKit\Classes`
|
15. In `Header Search Paths`, add a path to `$(SRCROOT)\Vendor\HockeyKit\Classes`
|
||||||
|
|
||||||

|
<img src="XcodeHeaderSearchPath_normal.png"/>
|
||||||
|
|
||||||
16. Search for `Other Linker Flags`
|
16. Search for `Other Linker Flags`
|
||||||
17. Double click on the build Setting titled Other Linker Flags.
|
17. Double click on the build Setting titled Other Linker Flags.
|
||||||
18. Add `-ObjC`
|
18. Add `-ObjC`
|
||||||
|
|
||||||

|
<img src="XcodeOtherLinkerFlags_normal.png"/>
|
||||||
|
|
||||||
19. Hit `Done`.
|
19. Hit `Done`.
|
||||||
20. Search for `preprocessor macros`
|
20. Search for `preprocessor macros`
|
||||||
|
|
||||||

|
<img src="XcodeMacros1_normal.png"/>
|
||||||
|
|
||||||
21. Select the top-most line and double-click the value field.
|
21. Select the top-most line and double-click the value field.
|
||||||
22. Click the + button.
|
22. Click the + button.
|
||||||
23. Enter the following string into the input field and finish with "Done".<pre><code>CONFIGURATION_$(CONFIGURATION)</code></pre>
|
23. Enter the following string into the input field and finish with "Done".<pre><code>CONFIGURATION_$(CONFIGURATION)</code></pre>
|
||||||
|
|
||||||

|
<img src="XcodeMacros2_normal.png"/>
|
||||||
|
|
||||||
Now you can use `#if defined (CONFIGURATION_ABCDEF)` directives in your code, where `ABCDEF` is the actual name of **YOUR** build configuration.
|
Now you can use `#if defined (CONFIGURATION_ABCDEF)` directives in your code, where `ABCDEF` is the actual name of **YOUR** build configuration.
|
||||||
24. 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:
|
24. 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:
|
||||||
|
BIN
docs/XcodeCopyBundle1_normal.png
Normal file
After Width: | Height: | Size: 110 KiB |
BIN
docs/XcodeCreateGroups_normal.png
Normal file
After Width: | Height: | Size: 239 KiB |
BIN
docs/XcodeFrameworks1_normal.png
Normal file
After Width: | Height: | Size: 123 KiB |
BIN
docs/XcodeFrameworks2_normal.png
Normal file
After Width: | Height: | Size: 131 KiB |
Before Width: | Height: | Size: 176 KiB |
Before Width: | Height: | Size: 109 KiB After Width: | Height: | Size: 128 KiB |
Before Width: | Height: | Size: 152 KiB After Width: | Height: | Size: 121 KiB |
Before Width: | Height: | Size: 155 KiB After Width: | Height: | Size: 128 KiB |