summaryrefslogtreecommitdiff
path: root/INSTALL.md
diff options
context:
space:
mode:
authorJason Wray <friedbunny@users.noreply.github.com>2017-07-18 12:36:22 -0400
committerGitHub <noreply@github.com>2017-07-18 12:36:22 -0400
commit05df451f3c370e6ba8a02d8b0268d88c23db269b (patch)
tree7f046e3b79be43e355ce4dcbca612cf214f1d51b /INSTALL.md
parent964287e5a4f93284b5b1e22da69ffc7c53e3e41f (diff)
downloadqtlocation-mapboxgl-05df451f3c370e6ba8a02d8b0268d88c23db269b.tar.gz
[build] Add ccache install reminder and docs (#9520)
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/INSTALL.md b/INSTALL.md
index 0789f5e0af..1c6c07f05f 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -11,14 +11,14 @@ 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.
@@ -34,17 +34,21 @@ targets.
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: