diff options
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 29 |
1 files changed, 18 insertions, 11 deletions
diff --git a/INSTALL.md b/INSTALL.md index 0789f5e0af..fb619770a1 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,8 +1,8 @@ # Building & Developing Mapbox GL Native from Source **Just trying to use Mapbox GL Native? You don't need to read this stuff! We -provide [easy-to-install, prebuilt versions of the Mapbox SDKs for iOS and Android -that you can download instantly and get started with fast](https://www.mapbox.com/mobile/).** +provide [easy-to-install, prebuilt versions of the Mapbox Maps SDKs for iOS and Android +that you can download instantly and get started with fast](https://www.mapbox.com/install/).** Still with us? These are the instructions you'll need to build Mapbox GL Native from source on a variety of platforms and set up a development environment. @@ -11,47 +11,54 @@ Your journey will start with getting the source code, then installing the dependencies, and then setting up a development environment, which varies depending on your operating system and what platform you want to develop for. -## 1: Getting the Source +## 1: Getting the source Clone the git repository: git clone https://github.com/mapbox/mapbox-gl-native.git cd mapbox-gl-native -## 2: Installing Dependencies +## 2: Installing dependencies These dependencies are required for all operating systems and all platform targets. - - Modern C++ compiler that supports `-std=c++14` + - Modern C++ compiler that supports `-std=c++14`\* - clang++ 3.5 or later _or_ - - g++-5 or later + - g++-4.9 or later - [CMake](https://cmake.org/) 3.1 or later (for build only) - [cURL](https://curl.haxx.se) (for build only) - [Node.js](https://nodejs.org/) 4.2.1 or later (for build only) - [`pkg-config`](https://wiki.freedesktop.org/www/Software/pkg-config/) (for build only) +**Note**: We partially support C++14 because GCC 4.9 does not fully implement the +final draft of the C++14 standard. More information in [DEVELOPING.md](DEVELOPING.md). + Depending on your operating system and target, you'll need additional dependencies: -### Additional Dependencies for Linux +### Additional dependencies for Linux - [`libcurl`](http://curl.haxx.se/libcurl/) (depends on OpenSSL) -### Additional Dependencies for macOS +### Additional dependencies for macOS - Apple Command Line Tools (available at [Apple Developer](https://developer.apple.com/download/more/)) - [Homebrew](http://brew.sh) - [Cask](http://caskroom.io/) (if building for Android) - [xcpretty](https://github.com/supermarin/xcpretty) (`gem install xcpretty`) +### Optional dependencies + +- [ccache](https://ccache.samba.org) (for build only; improves recompilation performance) + ## 3: Setting up a development environment & building See the relevant SDK documentation for next steps: -* [Mapbox Android SDK](platform/android/) -* [Mapbox iOS SDK](platform/ios/) -* [Mapbox macOS SDK](platform/macos/) +* [Maps SDK for Android](platform/android/) +* [Maps SDK for iOS](platform/ios/) +* [Maps SDK for iOS](platform/macos/) * [Mapbox Qt SDK](platform/qt/) * [Mapbox GL Native on Linux](platform/linux/) * [node-mapbox-gl-native](platform/node/) |