summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJustin R. Miller <incanus@users.noreply.github.com>2015-05-04 16:42:26 -0700
committerJustin R. Miller <incanus@users.noreply.github.com>2015-05-04 16:42:26 -0700
commita2e481eb740c15503f9e21d4fcf193b97a9dc03c (patch)
treee8f95c8d06a207d3b7ffb54aa548a4f0956ee34c /README.md
parentb952f7e64b3ee3c72f492ee7f5f24d3ab28e8683 (diff)
parent150c695177298e32efcd7b7be206e0ce64d74f80 (diff)
downloadqtlocation-mapboxgl-a2e481eb740c15503f9e21d4fcf193b97a9dc03c.tar.gz
Merge pull request #1415 from mapbox/1413-install-ios-docs
refs #1413: provide iOS docs with binary download
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 9d9bf508e0..e927a15767 100644
--- a/README.md
+++ b/README.md
@@ -48,8 +48,8 @@ Target OS X: 10.9+
If you merely want to install the library for iOS and try it out as an Objective-C consumer:
-0. Use [Homebrew](http://brew.sh/) to install Boost headers: `brew install boost`.
-1. Run `make ipackage`. The packaging script will produce the statically-linked `libMapboxGL.a`, `MapboxGL.bundle` for resources, and a `Headers` folder.
+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:
- `Headers` is in your *Header Search Paths* (`HEADER_SEARCH_PATHS`) build setting.
- `MapboxGL.bundle` is in your target's *Copy Bundle Resources* build phase.