summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMinh Nguyễn <mxn@1ec5.org>2015-03-16 12:29:57 -0700
committerMinh Nguyễn <mxn@1ec5.org>2015-03-16 12:29:57 -0700
commit8548927f3b72afbfc74bab1a707ece36443b434c (patch)
treed511c5b7e2d91da2747512e49a69f1f9bc867f1e /README.md
parent0d8b3aa5f79cb1b61ccc32d1df7c82256f78daf9 (diff)
downloadqtlocation-mapboxgl-8548927f3b72afbfc74bab1a707ece36443b434c.tar.gz
Added iOS project setup walkthrough
Lists the dependencies needed for linking. Fixes #967.
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/README.md b/README.md
index c3a6b0efd2..09759d84ef 100644
--- a/README.md
+++ b/README.md
@@ -46,7 +46,24 @@ 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, run `./scripts/package_ios.sh`. It requires the Boost headers to be installed, so use [Homebrew](http://brew.sh/) to install them (`brew install boost`). The packaging script will produce the statically-linked `libMapboxGL.a`, `MapboxGL.bundle` for resources, and a `Headers` folder.
+If you merely want to install the library for iOS and try it out as an Objective-C consumer:
+
+0. Use [Homebrew](http://brew.sh/) to install Boost headers: `brew install boost`.
+1. Run `./scripts/package_ios.sh`. The packaging script will produce the statically-linked `libMapboxGL.a`, `MapboxGL.bundle` for resources, and a `Headers` folder.
+2. Copy the contents of `build/ios/pkg/static` into your project. It should happen automatically, but ensure that:
+ - `Headers` is in your *Header Search Paths* (`HEADER_SEARCH_PATHS`) build setting.
+ - `MapboxGL.bundle` is in your target's *Copy Bundle Resources* build phase.
+ - `libMapboxGL.a` is in your target's *Link Binary With Libraries* build phase.
+3. Add the following Cocoa framework dependencies to your target's *Link Binary With Libraries* build phase:
+ - `GLKit.framework`
+ - `ImageIO.framework`
+ - `MobileCoreServices.framework`
+ - `SystemConfiguration.framework`
+ - `libc++.dylib`
+ - `libsqlite3.dylib`
+ - `libz.dylib`
+4. [Set the Mapbox API access token](#mapbox-api-access-tokens).
+5. `#import "MGLMapView.h"`
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.