diff options
| -rw-r--r-- | platform/ios/DEVELOPING.md | 27 | ||||
| -rw-r--r-- | platform/ios/INSTALL.md | 78 | ||||
| -rw-r--r-- | platform/ios/docs/pod-README.md | 56 | ||||
| -rw-r--r-- | platform/osx/INSTALL.md | 38 |
4 files changed, 116 insertions, 83 deletions
diff --git a/platform/ios/DEVELOPING.md b/platform/ios/DEVELOPING.md index b16ca430a3..3120ff84b5 100644 --- a/platform/ios/DEVELOPING.md +++ b/platform/ios/DEVELOPING.md @@ -4,19 +4,21 @@ This document explains how to build the Mapbox iOS SDK from source. It is intend ### 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. +The Mapbox iOS SDK and iosapp demo application build against the iOS 7.0 SDK. The SDK is intended to run on iOS 7.0 and above, while iosapp is intended to run on iOS 8.0 and above due to the use of a dynamic framework. Both require Xcode on a computer running OS X. ### Build [Install core dependencies](../../INSTALL.md), then run - make iproj +```bash +make iproj +``` -Which will create and open an Xcode workspace that includes both the SDK source and some Objective-C test applications. Before building, use the scheme picker button in the toolbar to change the scheme to “iosapp” and the destination to one of the simulators or connected devices listed in the menu. +which will create and open an Xcode workspace that includes both the SDK source and some Objective-C test applications. Before building, use the scheme picker button in the toolbar to change the scheme to “iosapp” and the destination to one of the simulators or connected devices listed in the menu. -If you don't have an Apple Developer account, change the destination to a simulator such as "iPhone 6" before you run and build the app. +If you don’t have an Apple Developer account, change the destination to a simulator such as “iPhone 6s” before you run and build the app. -`ipackage` is only one of several available `make` build targets. Others include: +`iproj` is only one of several available `make` rules. Others include: * `make ipackage` builds both dynamic and static frameworks in the Release configuration for devices and the iOS Simulator. * `make ipackage-sim` builds a dynamic framework in the Debug configuration for the iOS simulator. This is the fastest target. @@ -29,17 +31,26 @@ You can customize the build output by passing the following arguments into the ` * `FORMAT=dynamic` builds only a dynamic framework. `FORMAT=static` builds only a static framework, for compatibility with iOS 7.x. * `SYMBOLS=NO` strips the build output of any debug symbols, yielding much smaller binaries. +These targets require that you install [jazzy](https://github.com/realm/jazzy) for generating API documentation: + +```bash +[sudo] gem install jazzy +``` + ### Access tokens The included 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/). You will be prompted for this access token the first time you launch the demo or benchmarking application. In the iOS Simulator, you can paste your access token by pressing Command-V, holding down the left mouse button in the text field, and pressing the Paste button that appears. ### Test -Run +`make test-ios` builds and runs unit tests of cross-platform code as well as the SDK. - make test-ios +To run these unit tests on the command line, install ios-sim version 3.2.0 (not any other version): -To run the included unit tests and integration tests on the command line. +```bash +brew tap mapbox/homebrew-ios-sim-3 +brew install mapbox/homebrew-ios-sim-3/ios-sim +``` To instead run the tests in Xcode: diff --git a/platform/ios/INSTALL.md b/platform/ios/INSTALL.md index b3ead6d0d6..bdda38946d 100644 --- a/platform/ios/INSTALL.md +++ b/platform/ios/INSTALL.md @@ -1,16 +1,16 @@ # Integrating the Mapbox iOS SDK into your application -This document explains how to build a development version of Mapbox iOS SDK for the purpose of incorporating it into your own Cocoa Touch application. +This document explains how to build a development version of Mapbox iOS SDK for use in your own Cocoa Touch application. To use a production-ready version of the SDK, see the [Mapbox iOS SDK homepage](https://github.com/mapbox/ios-sdk). ### Requirements -The Mapbox iOS SDK and iosapp demo application build against the iOS 7.0 SDK. They are intended to run on iOS 7.0 and above on the following devices and their simulators: +The Mapbox iOS SDK application builds against the iOS 7.0 SDK. It is intended to run on iOS 7.0 and above on the following devices and their simulators: * iPhone 4S and above (5, 5c, 5s, 6, 6 Plus) * iPad 2 and above (3, 4, Mini, Air, Mini 2, Air 2) * iPod touch 5th generation and above -### Build +### Building the SDK 1. [Install core dependencies](../../INSTALL.md). @@ -20,20 +20,13 @@ The Mapbox iOS SDK and iosapp demo application build against the iOS 7.0 SDK. Th [sudo] gem install jazzy ``` -1. Install ios-sim version 3.2.0 (not any other version) for running `make test-ios`: - - ``` - brew tap mapbox/homebrew-ios-sim-3 - brew install mapbox/homebrew-ios-sim-3/ios-sim - ``` - 1. Run `make ipackage`. The packaging script will produce a `build/ios/pkg/` folder containing: - a `dynamic` folder containing a dynamically-linked fat framework with debug symbols for devices and the iOS Simulator - a `static` folder containing a statically-linked framework with debug symbols for devices and the iOS Simulator - a `documentation` folder with HTML API documentation - an example `Settings.bundle` containing an optional Mapbox Telemetry opt-out setting -### Install +### Installation There are a few ways to install the Mapbox iOS SDK: @@ -43,7 +36,7 @@ Currently, until [#1437](https://github.com/mapbox/mapbox-gl-native/issues/1437) 1. Zip up the build product. - ``` + ```bash cd build/ios/pkg/ ZIP=mapbox-ios-sdk.zip rm -f ../${ZIP} @@ -71,14 +64,13 @@ Currently, until [#1437](https://github.com/mapbox/mapbox-gl-native/issues/1437) 1. Run `pod update` to grab the newly-built library. - - -##### Testing Pre-Releases with CocoaPods +##### Testing pre-releases with CocoaPods To test pre-releases and/or betas, you can reference the pre-release like so in your Podfile: - pod 'Mapbox-iOS-SDK', podspec: 'https://raw.githubusercontent.com/mapbox/mapbox-gl-native/<insert branch or tag>/ios/Mapbox-iOS-SDK.podspec' - +```rb +pod 'Mapbox-iOS-SDK', podspec: 'https://raw.githubusercontent.com/mapbox/mapbox-gl-native/<insert branch or tag>/ios/Mapbox-iOS-SDK.podspec' +``` #### Dynamic framework @@ -86,7 +78,7 @@ This is the recommended workflow for manually integrating the SDK into an applic 1. Build from source manually per above. -1. Open the project editor and select your application target. Drag `build/ios/pkg/dynamic/Mapbox.framework` into the “Embedded Binaries” section of the General tab. (Don’t drag it into the “Linked Frameworks and Libraries” section; Xcode will add it there automatically.) In the sheet that appears, make sure “Copy items if needed” is checked, then click Finish. +1. Open the project editor, select your application target, then go to the General tab. Drag Mapbox.framework from the `build/ios/pkg/dynamic/` directory into the “Embedded Binaries” section. (Don’t drag it into the “Linked Frameworks and Libraries” section; Xcode will add it there automatically.) In the sheet that appears, make sure “Copy items if needed” is checked, then click Finish. 1. In the Build Phases tab, click the + button at the top and select “New Run Script Phase”. Enter the following code into the script text field: @@ -102,36 +94,42 @@ If your application targets iOS 7.x, you’ll need to install the static framewo 1. Build from source manually per above. -1. Drag the Mapbox.bundle and Mapbox.framework files in `build/ios/pkg/static` into the Project navigator, checking "Copy items if needed". It should happen automatically, but ensure that: - - - `Mapbox.framework` is listed in your `Link Binary With Libraries` build phase. - - Your *Framework Search Paths* (`FRAMEWORK_SEARCH_PATHS`) build setting includes the directory that contains `Mapbox.framework`. For most projects, the default value of `$(inherited) $(PROJECT_DIR)` should be sufficient. - - `Mapbox.bundle` is in your target's *Copy Bundle Resources* build phase. +1. Drag the Mapbox.bundle and Mapbox.framework from the `build/ios/pkg/static/` directory into the Project navigator. In the sheet that appears, make sure “Copy items if needed” is checked, then click Finish. Open the project editor and select your application target to verify that the following changes occurred automatically: + + - In the General tab, Mapbox.framework is listed in the “Linked Frameworks and Libraries” section. + - In the Build Settings tab, the “Framework Search Paths” (`FRAMEWORK_SEARCH_PATHS`) build setting includes the directory that contains Mapbox.framework. For most projects, the default value of `$(inherited) $(PROJECT_DIR)` should be sufficient. + - In the Build Phases tab, Mapbox.bundle is listed in the “Copy Bundle Resources” build phase. + +1. Back in the General tab, add the following Cocoa Touch frameworks and libraries to the “Linked Frameworks and Libraries” section: -1. **Optional** As [noted in the documentation](https://www.mapbox.com/ios-sdk/#telemetry_opt_out) you may use the provided Settings.bundle to provide a Telemetry opt out for users. To use the provided file, drag the `Settings.bundle` file in `build/ios/pkg` into the Project navigator, checking "Copy items if needed". It should happen automatically, but ensure that: + - GLKit.framework + - ImageIO.framework + - MobileCoreServices.framework + - QuartzCore.framework + - SystemConfiguration.framework + - libc++.tbd + - libsqlite3.tbd + - libz.tbd - - `Settings.bundle` is in your target's *Copy Bundle Resources* build phase. +### Configuration -1. Add the following Cocoa Touch frameworks and libraries to the “Linked Frameworks and Libraries” section: +1. Mapbox vector tiles require a Mapbox account and API access token. In the project editor, select the application target, then go to the Info tab. Under the “Custom iOS Target Properties” section, set `MGLMapboxAccessToken` to your access token. You can obtain an access token from the [Mapbox account page](https://www.mapbox.com/studio/account/tokens/). - - `GLKit.framework` - - `ImageIO.framework` - - `MobileCoreServices.framework` - - `QuartzCore.framework` - - `SystemConfiguration.framework` - - `libc++.tbd` - - `libsqlite3.tbd` - - `libz.tbd` +1. _(Optional)_ Mapbox Telemetry is a [powerful location analytics platform](https://www.mapbox.com/telemetry/) included in this SDK. By default, anonymized location and usage data is sent to Mapbox whenever the host application causes it to be gathered. This SDK provides users with a way to individually opt out of Mapbox Telemetry. You can also add this opt-out setting to your application’s Settings screen using a Settings bundle. An example Settings.bundle is available in the `build/ios/pkg/` directory; drag it into the Project navigator, checking “Copy items if needed” when prompted. In the project editor, verify that the following change occurred automatically: -### Use + - In the General tab, Settings.bundle is listed in the “Copy Bundle Resources” build phase. -1. Mapbox vector tiles require a Mapbox account and API access token. In the project editor, select the application target. In the Info tab, set `MGLMapboxAccessToken` to your access token. You can obtain one from the [Mapbox account page](https://www.mapbox.com/studio/account/tokens/). +### Usage -1. In a XIB or storyboard, add a View and set its custom class to `MGLMapView`. If you need to manipulate the map view programmatically, import the `Mapbox` module (Swift) or `Mapbox.h` umbrella header (Objective-C), then connect the map view to a new outlet in your view controller class. The resulting outlet declaration should look something like: +In a storyboard or XIB, add a view to your view controller. (Drag View from the Object library to the View Controller scene on the Interface Builder canvas.) In the Identity inspector, set the view’s custom class to `MGLMapView`. If you need to manipulate the map view programmatically: + +1. Switch to the Assistant Editor. +1. Import the `Mapbox` module. +1. Connect the map view to a new outlet in your view controller class. (Control-drag from the map view in Interface Builder to a valid location in your view controller implementation.) The resulting outlet declaration should look something like this: ```objc // ViewController.m -#import <Mapbox/Mapbox.h> +@import Mapbox; @interface ViewController : UIViewController @@ -148,7 +146,3 @@ class ViewController: UIViewController { @IBOutlet var mapView: MGLMapView! } ``` - -### Troubleshooting - -On OS X, you can also try clearing the Xcode cache with `make clear_xcode_cache`.
\ No newline at end of file diff --git a/platform/ios/docs/pod-README.md b/platform/ios/docs/pod-README.md index c3d6844a59..1633c7d126 100644 --- a/platform/ios/docs/pod-README.md +++ b/platform/ios/docs/pod-README.md @@ -16,7 +16,7 @@ The Mapbox iOS SDK may be installed as either a dynamic framework or a static fr This is the recommended workflow for manually integrating the SDK into an application targeting iOS 8 and above: -1. Open the project editor and select your application target. Drag `Mapbox.framework` from the `dynamic` folder into the “Embedded Binaries” section of the General tab. (Don’t drag it into the “Linked Frameworks and Libraries” section; Xcode will add it there automatically.) In the sheet that appears, make sure “Copy items if needed” is checked, then click Finish. +1. Open the project editor, select your application target, then go to the General tab. Drag Mapbox.framework from the `dynamic` folder into the “Embedded Binaries” section. (Don’t drag it into the “Linked Frameworks and Libraries” section; Xcode will add it there automatically.) In the sheet that appears, make sure “Copy items if needed” is checked, then click Finish. 1. In the Build Phases tab, click the + button at the top and select “New Run Script Phase”. Enter the following code into the script text field: @@ -33,52 +33,62 @@ bash "${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}/Mapbox.framework/strip-fra If your application targets iOS 7.x, you’ll need to install the static framework instead: -1. Drag the Mapbox.bundle and Mapbox.framework files in `static` into the Project navigator, checking "Copy items if needed". It should happen automatically, but ensure that: - - - `Mapbox.framework` is listed in your `Link Binary With Libraries` build phase. - - Your *Framework Search Paths* (`FRAMEWORK_SEARCH_PATHS`) build setting includes the directory that contains `Mapbox.framework`. For most projects, the default value of `$(inherited) $(PROJECT_DIR)` should be sufficient. - - `Mapbox.bundle` is in your target's *Copy Bundle Resources* build phase. +1. Drag Mapbox.bundle and Mapbox.framework from the `static` folder into the Project navigator. In the sheet that appears, make sure “Copy items if needed” is checked, then click Finish. Open the project editor and select your application target to verify that the following changes occurred automatically: -1. **Optional** As [noted in the documentation](https://www.mapbox.com/ios-sdk/#telemetry_opt_out) you may use the provided Settings.bundle to provide a Telemetry opt out for users. To use the provided file, drag the `Settings.bundle` file from the release root folder into the Project navigator, checking "Copy items if needed". It should happen automatically, but ensure that: - - - `Settings.bundle` is in your target's *Copy Bundle Resources* build phase. + - In the General tab, Mapbox.framework is listed in the “Linked Frameworks and Libraries” section. + - In the Build Settings tab, the “Framework Search Paths” (`FRAMEWORK_SEARCH_PATHS`) build setting includes the directory that contains Mapbox.framework. For most projects, the default value of `$(inherited) $(PROJECT_DIR)` should be sufficient. + - In the Build Phases tab, Mapbox.bundle is listed in the “Copy Bundle Resources” build phase. 1. Add the following Cocoa Touch frameworks and libraries to the “Linked Frameworks and Libraries” section: - - `GLKit.framework` - - `ImageIO.framework` - - `MobileCoreServices.framework` - - `QuartzCore.framework` - - `SystemConfiguration.framework` - - `libc++.tbd` - - `libsqlite3.tbd` - - `libz.tbd` + - GLKit.framework + - ImageIO.framework + - MobileCoreServices.framework + - QuartzCore.framework + - SystemConfiguration.framework + - libc++.tbd + - libsqlite3.tbd + - libz.tbd {{/STATIC}} ## Configuration -1. Mapbox vector tiles require a Mapbox account and API access token. In the project editor, select the application target. In the Info tab, set `MGLMapboxAccessToken` to your access token. You can obtain one from the [Mapbox account page](https://www.mapbox.com/studio/account/tokens/). +1. Mapbox vector tiles require a Mapbox account and API access token. In the project editor, select the application target, then go to the Info tab. Under the “Custom iOS Target Properties” section, set `MGLMapboxAccessToken` to your access token. You can obtain an access token from the [Mapbox account page](https://www.mapbox.com/studio/account/tokens/). + +1. In order to show the user’s current location on the map, the SDK must ask for the user’s permission to access Location Services. Go to the Info tab of the project editor. If your application supports iOS 7, set the `NSLocationUsageDescription` key to a message that explains to the user what their location is used for. If your application supports iOS 8 and above, set the `NSLocationAlwaysUsageDescription` and/or `NSLocationWhenInUseUsageDescription` key to this message instead. -1. In order to show the user’s position on the map, you must first ask for their permission. In iOS 8 and above, this is accomplished by creating and setting the `NSLocationAlwaysUsageDescription` and/or `NSLocationWhenInUseUsageDescription` key in the `Info.plist` file. +1. _(Optional)_ Mapbox Telemetry is a [powerful location analytics platform](https://www.mapbox.com/telemetry/) included in this SDK. By default, anonymized location and usage data is sent to Mapbox whenever the host application causes it to be gathered. This SDK provides users with a way to individually opt out of Mapbox Telemetry. You can also add this opt-out setting to your application’s Settings screen using a Settings bundle. An example Settings.bundle is provided with this SDK; drag it into the Project navigator, checking “Copy items if needed” when prompted. In the project editor, verify that the following change occurred automatically: -1. _(Optional)_ Mapbox Telemetry is a <a href="https://www.mapbox.com/telemetry/">powerful location analytics platform</a> included in this SDK. By default, anonymized location and usage data is sent to Mapbox whenever the host application causes it to be gathered. This SDK provides users with a way to individually opt out of Mapbox Telemetry. You can also add this opt-out setting to your application’s Settings screen, using the provided `Settings.bundle`. + - In the General tab, Settings.bundle is listed in the “Copy Bundle Resources” build phase. ## Usage -In a XIB or storyboard, add a Custom View and set its custom class to `MGLMapView`. If you need to manipulate the map view programmatically, import the Mapbox module in your view controller’s implementation file: +In a storyboard or XIB, add a view to your view controller. (Drag View from the Object library to the View Controller scene on the Interface Builder canvas.) In the Identity inspector, set the view’s custom class to `MGLMapView`. If you need to manipulate the map view programmatically: + +1. Switch to the Assistant Editor. +1. Import the `Mapbox` module. +1. Connect the map view to a new outlet in your view controller class. (Control-drag from the map view in Interface Builder to a valid location in your view controller implementation.) The resulting outlet declaration should look something like this: ```objc // ViewController.m @import Mapbox; + +@interface ViewController : UIViewController + +@property (strong) IBOutlet MGLMapView *mapView; + +@end ``` ```swift // ViewController.swift import Mapbox -``` -Then switch to the Assistant Editor and create an outlet to the map view. (Control-drag from the map view in Interface Builder to a valid location in your view controller implementation.) +class ViewController: UIViewController { + @IBOutlet var mapView: MGLMapView! +} +``` Full API documentation is included in this package, within the `documentation` folder. For more details, read “[First steps with the Mapbox iOS SDK](https://www.mapbox.com/help/first-steps-ios-sdk/)” and consult the [online examples](https://www.mapbox.com/ios-sdk/examples/). diff --git a/platform/osx/INSTALL.md b/platform/osx/INSTALL.md index e4566625eb..eaca3a2ba3 100644 --- a/platform/osx/INSTALL.md +++ b/platform/osx/INSTALL.md @@ -6,25 +6,43 @@ This document explains how to build the Mapbox OS X SDK and integrate it into yo The Mapbox OS X SDK requires the OS X 10.10.0 SDK or above. -### Build +### Building the SDK 1. [Install core dependencies](../../INSTALL.md). 1. Run `make xpackage`, which produces a `Mapbox.framework` in the `gyp/build/Release/` folder. -### Install +### Installation -1. Copy `gyp/build/Release/Mapbox.framework` into your project. +1. Open the project editor, select your application target, then go to the General tab. Drag Mapbox.framework from the `build/osx/Build/Products/Release/` directory into the “Embedded Binaries” section. (Don’t drag it into the “Linked Frameworks and Libraries” section; Xcode will add it there automatically.) In the sheet that appears, make sure “Copy items if needed” is checked, then click Finish. -1. In the project editor, select your application target, go to the General tab, and add `Mapbox.framework` to the *Embedded Binaries* section. +1. Mapbox vector tiles require a Mapbox account and API access token. In the project editor, select the application target, then go to the Info tab. Under the “Custom OS X Application Target Properties” section, set `MGLMapboxAccessToken` to your access token. You can obtain an access token from the [Mapbox account page](https://www.mapbox.com/studio/account/tokens/). -1. Mapbox vector tiles require a Mapbox account and API access token. In the project editor, select the application target. In the Info tab, set `MGLMapboxAccessToken` to your access token. You can obtain one from the [Mapbox account page](https://www.mapbox.com/studio/account/tokens/). +## Usage -1. In a XIB or storyboard, add a Custom View and set its custom class to `MGLMapView`. If you need to manipulate the map view programmatically, import the `Mapbox` module (Swift) or `Mapbox.h` umbrella header (Objective-C). +In a storyboard or XIB, add a view to your view controller. (Drag Custom View from the Object library to the View Controller scene on the Interface Builder canvas.) In the Identity inspector, set the view’s custom class to `MGLMapView`. If you need to manipulate the map view programmatically: -## Use +1. Switch to the Assistant Editor. +1. Import the `Mapbox` module. +1. Connect the map view to a new outlet in your view controller class. (Control-drag from the map view in Interface Builder to a valid location in your view controller implementation.) The resulting outlet declaration should look something like this: -The [Mapbox iOS SDK’s API documentation](https://www.mapbox.com/ios-sdk/api/) applies to the Mapbox OS X SDK with few differences, mostly around unimplemented features like user location tracking. +```objc +// ViewController.m +@import Mapbox; + +@interface ViewController : NSViewController + +@property (strong) IBOutlet MGLMapView *mapView; -## Troubleshooting +@end +``` -You can also try clearing the Xcode cache with `make clear_xcode_cache`. +```swift +// ViewController.swift +import Mapbox + +class ViewController: NSViewController { + @IBOutlet var mapView: MGLMapView! +} +``` + +The [Mapbox iOS SDK’s API documentation](https://www.mapbox.com/ios-sdk/api/) applies to the Mapbox OS X SDK with few differences, mostly around unimplemented features like user location tracking. |