diff options
Diffstat (limited to 'platform/osx/DEVELOPING.md')
| -rw-r--r-- | platform/osx/DEVELOPING.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/platform/osx/DEVELOPING.md b/platform/osx/DEVELOPING.md new file mode 100644 index 0000000000..3233b6302c --- /dev/null +++ b/platform/osx/DEVELOPING.md @@ -0,0 +1,23 @@ +# Contributing to the Mapbox OS X SDK + +This document explains how to build the Mapbox OS X SDK for contributing to the development of the SDK itself. + +### Requirements + +The Mapbox OS X SDK and the osxapp demo application run on OS X 10.10.0 and above. + +### Build + +1. [Install core dependencies](../../INSTALL.md). +1. Run `make xproj`. +1. Switch to the osxsdk or osxapp scheme. The former builds just the Cocoa framework, while the latter also builds a Cocoa demo application based on it. + +### 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/). You will be prompted for this access token the first time you launch the demo application. + +### Usage + +Through the OS X SDK, the demo application supports a variety of standard gestures and keyboard shortcuts. For more details, open Mapbox GL Help from the Help menu. + +You can also [integrate the Mapbox OS X SDK into your own Cocoa application](INSTALL.md). |