Update & simplify INSTALL.md (#11155)

* Update & simplify INSTALL.md

* Add "Launch Xcode" step

* Update INSTALL.md
This commit is contained in:
Lucas Wojciechowski
2018-02-12 12:06:36 -08:00
committed by GitHub
parent f0b12d581a
commit 94734441ce

View File

@@ -7,50 +7,38 @@ that you can download instantly and get started with fast](https://www.mapbox.co
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.
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.
Your journey will start with installing dependencies, then getting the source code, 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: Installing dependencies
Clone the git repository:
### macOS
git clone https://github.com/mapbox/mapbox-gl-native.git
cd mapbox-gl-native
1. Install [Xcode](https://developer.apple.com/xcode/)
2. Launch Xcode and install any updates
3. Install [Homebrew](http://brew.sh)
4. Install [Node.js](https://nodejs.org/), [CMake](https://cmake.org/), and [ccache](https://ccache.samba.org) with `brew install nodejs cmake ccache`
5. Install [xcpretty](https://github.com/supermarin/xcpretty) with `[sudo] gem install xcpretty` (optional, used for prettifying command line builds)
## 2: Installing dependencies
### Linux
These dependencies are required for all operating systems and all platform
targets.
- Modern C++ compiler that supports `-std=c++14`\*
- clang++ 3.5 or later _or_
- 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
Install the following:
- `clang++` 3.5 or later or `g++` 4.9 or later
- [git](https://git-scm.com/)
- [CMake](https://cmake.org/) 3.1 or later
- [cURL](https://curl.haxx.se)
- [Node.js](https://nodejs.org/) 4.2.1 or later
- [`libcurl`](http://curl.haxx.se/libcurl/) (depends on OpenSSL)
- [ccache](https://ccache.samba.org) (optional, improves recompilation performance)
### Additional dependencies for macOS
## 2: Getting the source
- 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`)
Clone the git repository:
### Optional dependencies
- [ccache](https://ccache.samba.org) (for build only; improves recompilation performance)
git clone https://github.com/mapbox/mapbox-gl-native.git
cd mapbox-gl-native
## 3: Setting up a development environment & building
@@ -58,7 +46,7 @@ See the relevant SDK documentation for next steps:
* [Maps SDK for Android](platform/android/)
* [Maps SDK for iOS](platform/ios/)
* [Maps SDK for iOS](platform/macos/)
* [Maps SDK for macOS](platform/macos/)
* [Mapbox Qt SDK](platform/qt/)
* [Mapbox GL Native on Linux](platform/linux/)
* [node-mapbox-gl-native](platform/node/)