diff options
| author | John Firebaugh <john.firebaugh@gmail.com> | 2018-04-29 15:27:49 -0700 |
|---|---|---|
| committer | John Firebaugh <john.firebaugh@gmail.com> | 2018-04-30 13:10:31 -0700 |
| commit | 9a4b806fa84bd3d2d1adb57eae4f9fdb5f79d9f9 (patch) | |
| tree | 9f5272734dcca3d00cc24fc2dba4f5bfc904f5f7 /platform/macos/INSTALL.md | |
| parent | 65a4ee2373d053ac5b8d179123fdc51b320a1bb7 (diff) | |
| download | qtlocation-mapboxgl-9a4b806fa84bd3d2d1adb57eae4f9fdb5f79d9f9.tar.gz | |
[docs] Make per-platform installation docs self-contained
I've seen several issues where users followed platform-specific install docs, but were unaware of additional prerequisites spelled out in the top-level INSTALL.md. So let's try making each platform's installation documentation self contained.
Diffstat (limited to 'platform/macos/INSTALL.md')
| -rw-r--r-- | platform/macos/INSTALL.md | 36 |
1 files changed, 29 insertions, 7 deletions
diff --git a/platform/macos/INSTALL.md b/platform/macos/INSTALL.md index c723d3e062..f0fb0278be 100644 --- a/platform/macos/INSTALL.md +++ b/platform/macos/INSTALL.md @@ -6,19 +6,41 @@ This document explains how to build a development version of the Mapbox Maps SDK The Mapbox Maps SDK for macOS requires the macOS 10.10.0 SDK (or above) and Xcode 8.0 (or above). To use this SDK with Xcode 7.3.1, download and use a symbols build from the [releases](https://github.com/mapbox/mapbox-gl-native/releases) page. -### Building the SDK from source - -To build the SDK from source: - -1. [Install core dependencies](../../INSTALL.md). +Before building, follow these steps to install prerequisites: +1. Install [Xcode](https://developer.apple.com/xcode/) +1. Launch Xcode and install any updates +1. Install [Homebrew](http://brew.sh) +1. Install [Node.js](https://nodejs.org/), [CMake](https://cmake.org/), and [ccache](https://ccache.samba.org): + ``` + brew install node cmake ccache + ``` +1. Install [xcpretty](https://github.com/supermarin/xcpretty) (optional, used for prettifying command line builds): + ``` + [sudo] gem install xcpretty + ``` 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. +### Building the SDK from source + +To build the SDK from source: + +1. Clone the git repository: + ``` + git clone https://github.com/mapbox/mapbox-gl-native.git + cd mapbox-gl-native + ``` + Note that this repository uses Git submodules. They'll be automatically checked out when you first run a `make` command, + but are not updated automatically. We recommended that you run `git submodule update` after pulling down new commits to + this repository. +1. Run: + ``` + make xpackage + ``` + This produces a `Mapbox.framework` in the `build/macos/pkg/` folder. ### Installation |