From 8151a1e17fce418177e2ef4b63e56d8a013238e9 Mon Sep 17 00:00:00 2001 From: "Justin R. Miller" Date: Mon, 4 May 2015 16:07:08 -0700 Subject: add HTML docs generation to iOS packaging script --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 06072f00fa..1b34fc33b2 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. -- cgit v1.2.1