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/ios | |
| 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/ios')
| -rw-r--r-- | platform/ios/DEVELOPING.md | 6 | ||||
| -rw-r--r-- | platform/ios/INSTALL.md | 26 |
2 files changed, 23 insertions, 9 deletions
diff --git a/platform/ios/DEVELOPING.md b/platform/ios/DEVELOPING.md index b407e78e4b..34388c2589 100644 --- a/platform/ios/DEVELOPING.md +++ b/platform/ios/DEVELOPING.md @@ -4,14 +4,10 @@ This document explains how to build the Mapbox Maps SDK for iOS from source. It ## Requirements -The Mapbox Maps SDK for iOS and iosapp demo application require iOS 9.0 or above. - -The Mapbox Maps SDK for iOS requires Xcode 9.1 or above to compile from source. +See the "Requirements" section in [INSTALL.md](INSTALL.md). ## Building the SDK -Make sure that you have the [core dependencies](../../INSTALL.md) installed. - Create and open an Xcode workspace that includes both the SDK source and some Objective-C test applications by running: ```bash diff --git a/platform/ios/INSTALL.md b/platform/ios/INSTALL.md index f253d3019d..3c79e4dcf8 100644 --- a/platform/ios/INSTALL.md +++ b/platform/ios/INSTALL.md @@ -18,16 +18,34 @@ The Mapbox Maps SDK for iOS requires: * Xcode 9.1 or higher to compile from source * Xcode 8.0 or higher to integrate the compiled framework into an application -### Building the SDK - -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 ``` +### Building the SDK + +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 iframework BUILDTYPE=Release`. The packaging script will produce a `build/ios/pkg/` folder containing: - a `dynamic` folder containing a dynamically-linked fat framework with debug symbols for devices and the iOS Simulator - a `documentation` folder with HTML API documentation |