summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJustin R. Miller <incanus@codesorcery.net>2014-11-12 12:37:06 -0800
committerJohn Firebaugh <john.firebaugh@gmail.com>2014-12-16 11:47:29 -0800
commitc3d2f3e66429ee2f199fdbb8e3db0405de9a724b (patch)
treeb53d4a4f2cbc1fce0f07ca8c356534e99620fee6 /README.md
parentb5ed45a6f62744b6e760bbe7285753cc0aa09953 (diff)
downloadqtlocation-mapboxgl-c3d2f3e66429ee2f199fdbb8e3db0405de9a724b.tar.gz
indicate submodule setup in common header of install info
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index 3c8fb2fd38..6f02773c78 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,11 @@ implemented in C++11, currently targeting iOS, OS X, and Ubuntu Linux.
We try to link to as many system-provided libraries as possible. When these are unavailable or too outdated, we run a thin build-script layer called [Mason](https://github.com/mapbox/mason) to automate builds, and load precompiled binary packages when possible.
+Be sure to pull down all submodules first:
+
+ git submodule init
+ git submodule update
+
## OS X
On OS X, we are using `zlib`, `SQLite3`, `libcurl` and `libpng` provided by the operating system. In addition to that, you need to have the Boost headers installed. To install all prerequisites, use [Homebrew](http://brew.sh/) and type `brew install pkg-config boost`.
@@ -43,12 +48,7 @@ iOS makes use of a Cocoa-specific API called [`mapbox-gl-cocoa`](https://github.
If you intend to develop here, `mapbox-gl-cocoa` is included as a submodule of the overall build setup.
-To pull down the submodule(s), run:
-
- git submodule init
- git submodule update
-
-Then, you can run `make iproj` to create and open an Xcode project with an iOS-specific view controller housing. This will automatically install required dependencies as well.
+You can run `make iproj` to create and open an Xcode project with an iOS-specific view controller housing. This will automatically install required dependencies as well.
Note that if you are doing OS X development as well, to toggle from OS X back to iOS, you will need to `make iproj` again.