summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDane Springmeyer <dane@mapbox.com>2014-05-30 13:56:48 -0700
committerDane Springmeyer <dane@mapbox.com>2014-05-30 13:56:48 -0700
commit3dd5d4cd24364aadfcbbc0518343f99e7061faef (patch)
tree3f094f5be306d0f64dcc4e93c8cad1b3b3c337cc /README.md
parentb24dc07fdddb13de9b984ce89a9d433fa431697a (diff)
downloadqtlocation-mapboxgl-3dd5d4cd24364aadfcbbc0518343f99e7061faef.tar.gz
add 'make setup' target a simplier way to get started than running ./setup-libraries.sh
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 22 insertions, 11 deletions
diff --git a/README.md b/README.md
index 6a788b9af7..47c6a8d1d9 100644
--- a/README.md
+++ b/README.md
@@ -19,12 +19,19 @@ implemented in C++11, currently targeting iOS, OS X, and Ubuntu Linux.
We use [mapnik-packaging](https://github.com/mapnik/mapnik-packaging) to build static libraries of
dependencies.
+First off: if you hit problems during development try:
+
+ make clean
+
+This will clear cached build data and update to the latest versions of dependencies.
+
## OS X
-Run `./setup-libraries.sh`
+First run:
+
+ make setup
-This downloads all required dependencies, builds them and creates universal libraries that can be
-used on both OS X and iOS.
+This downloads all required dependencies, builds them and creates universal libraries that can be used on both OS X and iOS.
To create projects, you can run:
- `make xproj`: Creates an Xcode project with OS X-specific handlers for HTTP downloads and
@@ -43,9 +50,11 @@ First, pull down the submodule(s):
git submodule init
git submodule update
-Then, because `libpng` isn't included in the iOS SDK, you will need to build a cross-architecture version
-yourself. Run `./setup-libraries.sh`, which is derived from Mapnik's cross-architecture build
-scripts. This will also run `./configure`.
+Then run:
+
+ make setup
+
+This downloads all required dependencies, builds them and creates universal libraries that can be used on both OS X and iOS.
Lastly, `make iproj` to create and open an Xcode project with an iOS-specific view controller housing.
@@ -68,13 +77,15 @@ Install glfw3 dependencies:
sudo apt-get install libxi-dev libglu1-mesa-dev x11proto-randr-dev x11proto-xext-dev libxrandr-dev x11proto-xf86vidmode-dev libxxf86vm-dev libxcursor-dev
-Build static dependencies:
+Then run:
+
+ make setup
- ./setup-libraries.sh
+This downloads all required dependencies, builds them and creates universal libraries that can be used on both OS X and iOS.
-This will automatically run configure for you and set the correct paths.
+You can then proceed to build the library like:
-You can then proceed to build the library, tests, or a GLFW app itself.
+ make linux
# Style
@@ -82,7 +93,7 @@ We're currently embedding the stylesheet JSON in the binary. To create the C++
file and the associated header, run
```
-bin/build-style.js
+node bin/build-style.js
```
This is automatically taken care of as a build phase.