From 78ea889202f267f821668627053f20dd2a9ff16a Mon Sep 17 00:00:00 2001 From: John Firebaugh Date: Thu, 28 May 2015 17:52:39 -0700 Subject: Latest homebrew appledoc should be good --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 123c507c9..bfc7a23a3 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,11 @@ 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 or later) for API docs generation. This is installable via homebrew: + ``` + brew install appledoc22 + brew link --force appledoc22 + ``` 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. -- cgit v1.2.3 From d2f710564994e902cab400caffbd46a0cddb57c2 Mon Sep 17 00:00:00 2001 From: John Firebaugh Date: Fri, 29 May 2015 10:57:03 -0700 Subject: Require appledoc v2.2-963 exactly --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index bfc7a23a3..5a37ff67e 100644 --- a/README.md +++ b/README.md @@ -58,11 +58,15 @@ pod 'MapboxGL' #### Manually -1. Install [appledoc](http://appledoc.gentlebytes.com/appledoc/) (2.2v963 or later) for API docs generation. This is installable via homebrew: - ``` - brew install appledoc22 - brew link --force appledoc22 - ``` +1. Install [appledoc](http://appledoc.gentlebytes.com/appledoc/) 2.2v963 for API docs generation (only this exact version works). + + ``` + wget https://github.com/tomaz/appledoc/releases/download/v2.2-963/appledoc.zip + tar xvzf 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. -- cgit v1.2.3 From 81c24e9d1e7e05b6824da6364db76d9bb4cd04b8 Mon Sep 17 00:00:00 2001 From: "Justin R. Miller" Date: Mon, 1 Jun 2015 18:54:58 -0700 Subject: wget -> curl since wget itself is a brew install --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5a37ff67e..3d06eba01 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ pod 'MapboxGL' 1. Install [appledoc](http://appledoc.gentlebytes.com/appledoc/) 2.2v963 for API docs generation (only this exact version works). ``` - wget https://github.com/tomaz/appledoc/releases/download/v2.2-963/appledoc.zip + curl -o appledoc.zip https://github.com/tomaz/appledoc/releases/download/v2.2-963/appledoc.zip tar xvzf appledoc.zip cp appledoc /usr/local/bin cp -Rf Templates/ ~/.appledoc -- cgit v1.2.3 From 847b1f03af18842b49ee86bfdf5d037982d0b63c Mon Sep 17 00:00:00 2001 From: "Justin R. Miller" Date: Mon, 1 Jun 2015 18:57:03 -0700 Subject: appledoc download is a redirect --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3d06eba01..337de0743 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ pod 'MapboxGL' 1. Install [appledoc](http://appledoc.gentlebytes.com/appledoc/) 2.2v963 for API docs generation (only this exact version works). ``` - curl -o appledoc.zip https://github.com/tomaz/appledoc/releases/download/v2.2-963/appledoc.zip + curl -L -o appledoc.zip https://github.com/tomaz/appledoc/releases/download/v2.2-963/appledoc.zip tar xvzf appledoc.zip cp appledoc /usr/local/bin cp -Rf Templates/ ~/.appledoc -- cgit v1.2.3 From 88b3cfe37de7918723fb9ebb6b886aaec4808bcd Mon Sep 17 00:00:00 2001 From: "Justin R. Miller" Date: Mon, 1 Jun 2015 18:57:25 -0700 Subject: .zip != .tgz --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 337de0743..69bae6d03 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ pod 'MapboxGL' ``` curl -L -o appledoc.zip https://github.com/tomaz/appledoc/releases/download/v2.2-963/appledoc.zip - tar xvzf appledoc.zip + unzip appledoc.zip cp appledoc /usr/local/bin cp -Rf Templates/ ~/.appledoc ``` -- cgit v1.2.3 From 295dc73c1af288c85e75a4fcaccdd9cb1580afd2 Mon Sep 17 00:00:00 2001 From: Brad Leege Date: Wed, 3 Jun 2015 11:57:49 -0500 Subject: Adding iOS Testing Header To Draw Attention --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 69bae6d03..0d95b51a3 100644 --- a/README.md +++ b/README.md @@ -90,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). -- cgit v1.2.3