diff options
Diffstat (limited to 'platform/ios/DEVELOPING.md')
-rw-r--r-- | platform/ios/DEVELOPING.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/platform/ios/DEVELOPING.md b/platform/ios/DEVELOPING.md new file mode 100644 index 0000000000..c8445aade3 --- /dev/null +++ b/platform/ios/DEVELOPING.md @@ -0,0 +1,47 @@ +# Contributing to the Mapbox iOS SDK + +This document explains how to build the Mapbox iOS SDK and the osxapp demo application for the purpose of developing the SDK itself. + +### Requirements + +The Mapbox iOS SDK and iosapp demo application build against the iOS 7.0 SDK and require Xcode on a computer running OS X. + +### Build + +[Install core dependencies](../../INSTALL.md), then run + + make iproj + +Which will create and open an Xcode project that 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. + +### Access Tokens + +_The demo applications use Mapbox vector tiles, which require a Mapbox account and API access token. Obtain an access token on the [Mapbox account page](https://www.mapbox.com/studio/account/tokens/)._ + +Set up the access token by editing the scheme for the application target, then adding an environment variable with the name `MAPBOX_ACCESS_TOKEN`. + +![edit scheme](https://cloud.githubusercontent.com/assets/98601/5460702/c4610262-8519-11e4-873a-8597821da468.png) + +![setting access token in Xcode scheme](https://cloud.githubusercontent.com/assets/162976/5349358/0a086f00-7f8c-11e4-8433-bdbaccda2b58.png) + +### Test + +Run + + make itest + +To run the included integration tests on the command line. + +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. + +### Usage + +- Pan to move +- Pinch to zoom +- Use two fingers to rotate +- Double-tap to zoom in one level +- Two-finger single-tap to zoom out one level +- Double-tap, long-pressing the second, then pan up and down to "quick zoom" (iPhone only, meant for one-handed use) +- Use the debug menu to add test annotations, reset position, and cycle through the debug options. |