summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJustin R. Miller <incanus@codesorcery.net>2015-05-05 17:00:25 -0700
committerJustin R. Miller <incanus@codesorcery.net>2015-05-05 17:00:25 -0700
commit388d5da3055b0a0766e8f1b247c9ef67d22d9b1e (patch)
tree6eec4d8f16ddc1446cc506426a5de31105970bf1 /README.md
parent1e8a480e1b7591b15bd0c6759dbd9d9418805cd7 (diff)
downloadqtlocation-mapboxgl-388d5da3055b0a0766e8f1b247c9ef67d22d9b1e.tar.gz
add mention of CocoaPods to get ahead of release
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8b5dd5760f..358e5a5247 100644
--- a/README.md
+++ b/README.md
@@ -47,6 +47,19 @@ Target OS X: 10.9+
If you merely want to install the library for iOS and try it out as an Objective-C consumer:
+### CocoaPods
+
+CocoaPods is preferred. As of yet, Mapbox GL isn't in the global specs repo, but you can use it like so in your `Podfile`:
+
+```ruby
+use_frameworks!
+pod 'MapboxGL', :podspec => 'https://raw.githubusercontent.com/mapbox/mapbox-gl-native/master/ios/MapboxGL.podspec'
+```
+
+Once the library stabilizes, a mere `pod 'MapboxGL'` will work.
+
+### Manually
+
0. Use [Homebrew](http://brew.sh/) to install Boost headers and [appledoc](http://gentlebytes.com/appledoc/): `brew install boost 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.
2. Copy the contents of `build/ios/pkg/static` into your project. It should happen automatically, but ensure that: