f8f735b574
Rewrote some copy to provide more context and link to more GL-related repos, including GL JS. Put the various SDKs in a table so we can show the various CI bot status images. Integrated target list into the relevant documents. Rewrote large portions of iOS and OS X setup documentation to guide normal developers to more friendly places. Combined some Android documentation. Moved SDK-specific documentation into platform/. Added a temporary readme in ios/ that points to the one in platform/ios/.
61 lines
2.4 KiB
Markdown
61 lines
2.4 KiB
Markdown
# 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/).**
|
|
|
|
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.
|
|
|
|
## 1: Getting the Source
|
|
|
|
Mapbox GL Native uses git submodules, so you'll need to initialize and update
|
|
them after cloning the source from Git.
|
|
|
|
git clone https://github.com/mapbox/mapbox-gl-native.git
|
|
cd mapbox-gl-native
|
|
git submodule init
|
|
git submodule update
|
|
|
|
Default styles in the [Mapbox GL Style Spec format](https://github.com/mapbox/mapbox-gl-style-spec) are included at `./styles` as a submodule. See the [styles project](https://github.com/mapbox/mapbox-gl-styles) to report problems or to contribute to these styles.
|
|
|
|
## 2: Installing Dependencies
|
|
|
|
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
|
|
- Python 2.x (for build only)
|
|
- [`pkg-config`](https://wiki.freedesktop.org/www/Software/pkg-config/) (for build only)
|
|
- [`libtool`](https://www.gnu.org/software/libtool/) (for build only)
|
|
- [`automake`](https://www.gnu.org/software/automake/) (for build only)
|
|
|
|
Depending on your operating system and target, you'll need additional
|
|
dependencies:
|
|
|
|
### Additional Dependencies for Linux
|
|
|
|
- [`libcurl`](http://curl.haxx.se/libcurl/) (depends on OpenSSL)
|
|
|
|
### Additional Dependencies for OS X
|
|
|
|
- Apple Command Line Tools (available at [Apple Developer](https://developer.apple.com/downloads))
|
|
- [Homebrew](http://brew.sh)
|
|
- [Cask](http://caskroom.io/) (if building for Android)
|
|
|
|
## 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 OS X SDK](platform/osx/)
|
|
* [Mapbox GL Native on Linux](platform/linux/)
|
|
* [node-mapbox-gl-native](platform/node/)
|