summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMinh Nguyễn <mxn@1ec5.org>2016-01-22 01:18:35 -0800
committerMinh Nguyễn <mxn@1ec5.org>2016-01-22 14:45:58 -0800
commit1ddce4cb3a7a1bd0b3fe9c15f09b4bb3c642c86d (patch)
tree904617d14f4fa9f9714fe4732f6475071a11bf49
parent8eb3489f1b91ea7558e2f597658abf22fd8e9876 (diff)
downloadqtlocation-mapboxgl-1ddce4cb3a7a1bd0b3fe9c15f09b4bb3c642c86d.tar.gz
[ios] Documented make targets
-rw-r--r--platform/ios/DEVELOPING.md14
-rw-r--r--platform/ios/INSTALL.md4
2 files changed, 16 insertions, 2 deletions
diff --git a/platform/ios/DEVELOPING.md b/platform/ios/DEVELOPING.md
index 75ad15fdd5..f4d903532f 100644
--- a/platform/ios/DEVELOPING.md
+++ b/platform/ios/DEVELOPING.md
@@ -16,6 +16,20 @@ Which will create and open an Xcode project that can build the entire library fr
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.
+`ipackage` is only one of several available `make` build targets. 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.
+* `make ipackage-strip` builds both dynamic and static frameworks in the Release configuration, stripped of debug symbols, for devices and the iOS Simulator.
+* `make iframework` builds a dynamic framework in the Release configuration for devices and the iOS Simulator. The CocoaPods pod downloads the output of this target.
+
+You can customize the build output by passing the following arguments into the `make` invocation:
+
+* `BITCODE=NO` builds without Bitcode support.
+* `BUILD_DEVICE=false` builds only for the iOS Simulator.
+* `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.
+
### 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/)._
diff --git a/platform/ios/INSTALL.md b/platform/ios/INSTALL.md
index 55f2f6b4c3..25c460d32e 100644
--- a/platform/ios/INSTALL.md
+++ b/platform/ios/INSTALL.md
@@ -21,8 +21,8 @@ The Mapbox iOS SDK and iosapp demo application build against the iOS 7.0 SDK. Th
```
1. Run `make ipackage`. The packaging script will produce a `build/ios/pkg/` folder containing:
- - a `dynamic` folder containing a dynamically-linked fat framework
- - a `static` folder containing a statically-linked framework
+ - 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` for providing the required Mapbox Metrics opt-out setting