iOS README clarifications

This commit is contained in:
Justin R. Miller
2015-05-05 17:02:25 -07:00
parent 388d5da305
commit 583dfa7a2f

View File

@@ -45,9 +45,9 @@ Target OS X: 10.9+
## iOS
If you merely want to install the library for iOS and try it out as an Objective-C consumer:
### Use
### CocoaPods
#### CocoaPods
CocoaPods is preferred. As of yet, Mapbox GL isn't in the global specs repo, but you can use it like so in your `Podfile`:
@@ -58,7 +58,7 @@ pod 'MapboxGL', :podspec => 'https://raw.githubusercontent.com/mapbox/mapbox-gl-
Once the library stabilizes, a mere `pod 'MapboxGL'` will work.
### Manually
#### Manually
0. Use [Homebrew](http://brew.sh/) to install Boost headers and [appledoc](http://gentlebytes.com/appledoc/): `brew install boost appledoc`.
1. Run `make ipackage`. The packaging script will produce the statically-linked `libMapboxGL.a`, `MapboxGL.bundle` for resources, a `Headers` folder, and a `Docs` folder with HTML API documentation.
@@ -80,6 +80,8 @@ Once the library stabilizes, a mere `pod 'MapboxGL'` will work.
5. [Set the Mapbox API access token](#mapbox-api-access-tokens).
6. `#import "MapboxGL.h"`
### Development
If you want to build from source and/or contribute to development of the project, run `make iproj`, which will create and open an Xcode project which can build the entire library from source as well as an Objective-C test app. If you don't have an Apple Developer account, change the destination from "My Mac" to a simulator such as "iPhone 6" before you run and build the app.
You can run `make itest` to run the included integration tests. Requires `gem install xcpretty`. If you want to run the tests in Xcode instead, first `make ipackage` to create a local static library version, then open `test/ios/ios-tests.xcodeproj`, and lastly `Command + U` on the `Mapbox GL Tests` application target.