summaryrefslogtreecommitdiff
path: root/platform/macos/INSTALL.md
diff options
context:
space:
mode:
authorMinh Nguyễn <mxn@1ec5.org>2017-01-15 13:18:21 -0800
committerGitHub <noreply@github.com>2017-01-15 13:18:21 -0800
commit4adcdac7b5eeca79411e877ef11d5248f4107963 (patch)
treef9ce3ea04138e74c68ebee3a52bd97128ffb6cf7 /platform/macos/INSTALL.md
parent15caf0fd6362c525adc0502696226801c6622b1c (diff)
downloadqtlocation-mapboxgl-4adcdac7b5eeca79411e877ef11d5248f4107963.tar.gz
[macos] Upgrade macOS deployment and distribution (#7649)macos-v0.3.0-rc.1
* [macos] Updated deployment scripts Ported fixes from #6581 and #6740. * [macos] Acknowledge AppleScript support * [macos] Prepared for published documentation Also added link to Dash docset. * [macos] Added CocoaPods podspecs Ported from #5653. * [macos] Rewrote readme; updated screenshot * [macos] Include setup instructions in standalone docs
Diffstat (limited to 'platform/macos/INSTALL.md')
-rw-r--r--platform/macos/INSTALL.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/platform/macos/INSTALL.md b/platform/macos/INSTALL.md
index a4b944611d..f8b4c675de 100644
--- a/platform/macos/INSTALL.md
+++ b/platform/macos/INSTALL.md
@@ -11,6 +11,13 @@ The Mapbox macOS SDK requires the macOS 10.10.0 SDK (or above) and Xcode 7.3 (or
Grab a [prebuilt release](https://github.com/mapbox/mapbox-gl-native/releases/) – look for the releases that begin with “macos-” – or build the SDK from source:
1. [Install core dependencies](../../INSTALL.md).
+
+1. Install [jazzy](https://github.com/realm/jazzy) for generating API documentation:
+
+ ```
+ [sudo] gem install jazzy
+ ```
+
1. Run `make xpackage`, which produces a `Mapbox.framework` in the `build/macos/pkg/` folder.
### Installation
@@ -64,4 +71,4 @@ script AppDelegate
end script
```
-Run `make xdocument` to generate complete API documentation. The [Mapbox iOS SDK](https://www.mapbox.com/ios-sdk/)’s [API documentation](https://www.mapbox.com/ios-sdk/api/) and [online examples](https://www.mapbox.com/ios-sdk/examples/) apply to the Mapbox macOS SDK with few differences, mostly around unimplemented features like user location tracking.
+For further instructions, consult the [macOS SDK documentation](https://mapbox.github.io/mapbox-gl-native/macos/) or run `make xdocument` to generate the documentation. The [Mapbox iOS SDK](https://www.mapbox.com/ios-sdk/)’s [API documentation](https://www.mapbox.com/ios-sdk/) and [online examples](https://www.mapbox.com/ios-sdk/examples/) apply to the Mapbox macOS SDK with few differences, mostly around unimplemented features like user location tracking.