diff options
| -rw-r--r-- | platform/macos/INSTALL.md | 8 | ||||
| -rw-r--r-- | platform/macos/README.md | 18 | ||||
| -rw-r--r-- | platform/macos/docs/pod-README.md | 6 |
3 files changed, 19 insertions, 13 deletions
diff --git a/platform/macos/INSTALL.md b/platform/macos/INSTALL.md index f8b4c675de..ef04267c47 100644 --- a/platform/macos/INSTALL.md +++ b/platform/macos/INSTALL.md @@ -1,14 +1,14 @@ -# Integrating the Mapbox macOS SDK into your application +# Integrating a custom build of the Mapbox macOS SDK into your application -This document explains how to build the Mapbox macOS SDK and integrate it into your own Cocoa application. +This document explains how to build a development version of the Mapbox macOS SDK from source and integrate it into your own Cocoa application. This process is for advanced developers who want to get a glimpse of the SDK’s development between releases. To use a production-ready version of the SDK, see the [Mapbox macOS SDK homepage](https://mapbox.github.io/mapbox-gl-native/macos/). ### Requirements The Mapbox macOS SDK requires the macOS 10.10.0 SDK (or above) and Xcode 7.3 (or above). -### Building the SDK +### Building the SDK from source -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: +To build the SDK from source: 1. [Install core dependencies](../../INSTALL.md). diff --git a/platform/macos/README.md b/platform/macos/README.md index aea5ba0d6a..14b3e0cf16 100644 --- a/platform/macos/README.md +++ b/platform/macos/README.md @@ -1,10 +1,10 @@ -# Mapbox macOS SDK +# [Mapbox macOS SDK](https://mapbox.github.io/mapbox-gl-native/macos/) [](https://www.bitrise.io/app/155ef7da24b38dcd) Put interactive, scalable world maps into your native Cocoa application with the Mapbox macOS SDK. -* Mapbox-curated [map styles](https://www.mapbox.com/maps/) and [vector tiles](https://www.mapbox.com/vector-tiles/) make it easy to get started. +* Mapbox-curated [map styles](https://www.mapbox.com/maps/) and [OpenStreetMap-based](https://www.mapbox.com/vector-tiles/mapbox-streets-v7/) [vector tiles](https://www.mapbox.com/vector-tiles/) make it easy to get started. * Customize every aspect of the map’s appearance in code or visually using [Mapbox Studio](https://www.mapbox.com/mapbox-studio/). * High-performance OpenGL rendering and multitouch gestures keep your users happy. * A well-designed, fully documented API helps you stay productive. @@ -14,11 +14,17 @@ Put interactive, scalable world maps into your native Cocoa application with the The Mapbox macOS SDK is compatible with macOS 10.10.0 and above for Cocoa applications developed in Objective-C, Swift, Interface Builder, or AppleScript. For hybrid applications, consider [Mapbox GL JS](https://github.com/mapbox/mapbox-gl-js/). -* [Integrate the Mapbox macOS SDK into your application](INSTALL.md) +Information for Mac developers: + +* [Integrate the Mapbox macOS SDK into your application](https://mapbox.github.io/mapbox-gl-native/macos/) +* [Learn how to use the Mapbox macOS SDK](https://mapbox.github.io/mapbox-gl-native/macos/) +* [Browse example styles designed in Mapbox Studio](https://www.mapbox.com/gallery/) + +Information for contributors: + +* [Build the Mapbox macOS SDK from source](INSTALL.md) * [Contribute to the Mapbox macOS SDK](DEVELOPING.md) -* [Mapbox macOS SDK reference documentation](https://mapbox.github.io/mapbox-gl-native/macos/) -* [See example styles designed in Mapbox Studio](https://www.mapbox.com/gallery/) -* [Hand-authoring a macOS SDK–compatible style](https://www.mapbox.com/mapbox-gl-style-spec/) +* [Mapbox Style Specification](https://www.mapbox.com/mapbox-gl-style-spec/) * [Mapbox Vector Tile Specification](https://www.mapbox.com/developers/vector-tiles/) Mapbox does not officially support the Mapbox macOS SDK to the same extent as the Mapbox iOS SDK; however, bug reports and pull requests are certainly welcome. diff --git a/platform/macos/docs/pod-README.md b/platform/macos/docs/pod-README.md index 6d45a68c34..33386340c6 100644 --- a/platform/macos/docs/pod-README.md +++ b/platform/macos/docs/pod-README.md @@ -2,7 +2,7 @@ Put interactive, scalable world maps into your native Cocoa application with the open-source Mapbox macOS SDK. -* Mapbox-curated [map styles](https://www.mapbox.com/maps/) and [vector tiles](https://www.mapbox.com/vector-tiles/) make it easy to get started. +* Mapbox-curated [map styles](https://www.mapbox.com/maps/) and [OpenStreetMap-based](https://www.mapbox.com/vector-tiles/mapbox-streets-v7/) [vector tiles](https://www.mapbox.com/vector-tiles/) make it easy to get started. * Customize every aspect of the map’s appearance in code or visually using [Mapbox Studio](https://www.mapbox.com/mapbox-studio/). * High-performance OpenGL rendering and multitouch gestures keep your users happy. * A well-designed, fully documented API helps you stay productive. @@ -12,10 +12,10 @@ Put interactive, scalable world maps into your native Cocoa application with the The Mapbox macOS SDK is compatible with macOS 10.10.0 and above for Cocoa applications developed in Objective-C, Swift, Interface Builder, or AppleScript. For hybrid applications, consider [Mapbox GL JS](https://www.mapbox.com/mapbox-gl-js/). -Mapbox macOS SDK releases are [available on GitHub](https://github.com/mapbox/mapbox-gl-native/releases/) – look for the releases that begin with “macos-”. You can also integrate the Mapbox macOS SDK into your application using CocoaPods. - ## Installation +1. Download the [latest Mapbox macOS SDK release](https://github.com/mapbox/mapbox-gl-native/releases/) from GitHub – look for a release that begins with “macos-”. (Alternatively, you can integrate the Mapbox macOS SDK into your application [using CocoaPods](https://cocoapods.org/pods/Mapbox-macOS-SDK). If you do use CocoaPods, skip the next step.) + 1. Open the project editor, select your application target, then go to the General tab. Drag Mapbox.framework 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. 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 macOS 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/). |