summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAnsis Brammanis <brammanis@gmail.com>2015-06-03 19:20:41 -0400
committerAnsis Brammanis <brammanis@gmail.com>2015-06-03 19:20:41 -0400
commit9c03b396c0a36af28cbaf490c75850af18f780d2 (patch)
tree5c4d94933a2d12df30d1ce1af6eb87d27e024402 /README.md
parent2bd7e4550296ce5f58abef93667bb92464317dc9 (diff)
parent295dc73c1af288c85e75a4fcaccdd9cb1580afd2 (diff)
downloadqtlocation-mapboxgl-9c03b396c0a36af28cbaf490c75850af18f780d2.tar.gz
Merge remote-tracking branch 'origin/master' into HEAD
Conflicts: src/mbgl/renderer/painter_fill.cpp
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index 389f03242b..625e970faa 100644
--- a/README.md
+++ b/README.md
@@ -58,7 +58,15 @@ pod 'MapboxGL'
#### Manually
-1. Install [appledoc](http://appledoc.gentlebytes.com/appledoc/) for API docs generation. We recommend [`2.2v963`](https://github.com/tomaz/appledoc/releases/tag/v2.2-963), which currently isn't available in Homebrew.
+1. Install [appledoc](http://appledoc.gentlebytes.com/appledoc/) 2.2v963 for API docs generation (only this exact version works).
+
+ ```
+ curl -L -o appledoc.zip https://github.com/tomaz/appledoc/releases/download/v2.2-963/appledoc.zip
+ unzip appledoc.zip
+ cp appledoc /usr/local/bin
+ cp -Rf Templates/ ~/.appledoc
+ ```
+
1. Run `make ipackage`. The packaging script will produce the statically-linked `libMapboxGL.a`, `MapboxGL.bundle` for resources, a `Headers` folder, and a `Docs` folder with HTML API documentation.
1. Copy the contents of `build/ios/pkg/static` into your project. It should happen automatically, but ensure that:
- `Headers` is in your *Header Search Paths* (`HEADER_SEARCH_PATHS`) build setting.
@@ -82,6 +90,7 @@ pod 'MapboxGL'
If you want to build from source and/or contribute to development of the project, run `make iproj`, which will create and open an Xcode project which can build the entire library from source as well as an Objective-C test app. If you don't have an Apple Developer account, change the destination from "My Mac" to a simulator such as "iPhone 6" before you run and build the app.
+#### Testing
You can run `make itest` to run the included integration tests. Requires `gem install xcpretty`. If you want to run the tests in Xcode instead, first `make ipackage` to create a local static library version, then open `test/ios/ios-tests.xcodeproj`, and lastly `Command + U` on the `Mapbox GL Tests` application target.
Target devices: iPhone 4S and above (5, 5c, 5s, 6, 6 Plus) and iPad 2 and above (3, 4, Mini, Air, Mini 2, Air 2).