summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMinh Nguyễn <mxn@1ec5.org>2017-01-16 10:16:40 -0800
committerGitHub <noreply@github.com>2017-01-16 10:16:40 -0800
commit13b97dd0cebffe36b187bdb74923910def6bd87b (patch)
treeb5def9897ddfcbafab1aeacab6d32ca3cf8c58e5
parent4adcdac7b5eeca79411e877ef11d5248f4107963 (diff)
downloadqtlocation-mapboxgl-13b97dd0cebffe36b187bdb74923910def6bd87b.tar.gz
[ios, macos] Correct podspecs, readmes (#7730)
* [macos] RC 1 errata Synchronized bundled README installation instructions with those in INSTALL.md. Bumped screenshot up a bit. Corrected link to published documentation. * [ios, macos] Corrected podspec URLs Fixed podspec linter errors. The podspecs were pointing to unreachable (or soon to be unreachable) screenshot URLs. The -symbols podspecs’ names additionally needed to differ from the normal podspecs’ names.
-rw-r--r--platform/ios/Mapbox-iOS-SDK-symbols.podspec8
-rw-r--r--platform/ios/Mapbox-iOS-SDK.podspec6
-rw-r--r--platform/macos/Mapbox-macOS-SDK-symbols.podspec14
-rw-r--r--platform/macos/Mapbox-macOS-SDK.podspec12
-rw-r--r--platform/macos/README.md6
-rw-r--r--platform/macos/docs/pod-README.md19
6 files changed, 41 insertions, 24 deletions
diff --git a/platform/ios/Mapbox-iOS-SDK-symbols.podspec b/platform/ios/Mapbox-iOS-SDK-symbols.podspec
index 297cf857bf..1098c5cd10 100644
--- a/platform/ios/Mapbox-iOS-SDK-symbols.podspec
+++ b/platform/ios/Mapbox-iOS-SDK-symbols.podspec
@@ -1,14 +1,16 @@
Pod::Spec.new do |m|
- m.name = 'Mapbox-iOS-SDK'
- m.version = '3.4.0-beta.7-symbols'
+ version = '3.4.0-beta.7'
+
+ m.name = 'Mapbox-iOS-SDK-symbols'
+ m.version = "#{version}-symbols"
m.summary = 'Open source vector map solution for iOS with full styling capabilities.'
m.description = 'Open source, OpenGL-based vector map solution for iOS with full styling capabilities and Cocoa Touch APIs.'
m.homepage = 'https://www.mapbox.com/ios-sdk/'
m.license = { :type => 'BSD', :file => 'LICENSE.md' }
m.author = { 'Mapbox' => 'mobile@mapbox.com' }
- m.screenshot = 'https://raw.githubusercontent.com/mapbox/mapbox-gl-native/master/platform/ios/screenshot.png'
+ m.screenshot = "https://www.mapbox.com/ios-sdk/api/#{version}/img/screenshot.png"
m.social_media_url = 'https://twitter.com/mapbox'
m.documentation_url = 'https://www.mapbox.com/ios-sdk/api/'
diff --git a/platform/ios/Mapbox-iOS-SDK.podspec b/platform/ios/Mapbox-iOS-SDK.podspec
index 7906c6ea31..cf3f3afa61 100644
--- a/platform/ios/Mapbox-iOS-SDK.podspec
+++ b/platform/ios/Mapbox-iOS-SDK.podspec
@@ -1,14 +1,16 @@
Pod::Spec.new do |m|
+ version = '3.4.0-beta.7'
+
m.name = 'Mapbox-iOS-SDK'
- m.version = '3.4.0-beta.7'
+ m.version = version
m.summary = 'Open source vector map solution for iOS with full styling capabilities.'
m.description = 'Open source, OpenGL-based vector map solution for iOS with full styling capabilities and Cocoa Touch APIs.'
m.homepage = 'https://www.mapbox.com/ios-sdk/'
m.license = { :type => 'BSD', :file => 'LICENSE.md' }
m.author = { 'Mapbox' => 'mobile@mapbox.com' }
- m.screenshot = 'https://raw.githubusercontent.com/mapbox/mapbox-gl-native/master/platform/ios/screenshot.png'
+ m.screenshot = "https://www.mapbox.com/ios-sdk/api/#{version}/img/screenshot.png"
m.social_media_url = 'https://twitter.com/mapbox'
m.documentation_url = 'https://www.mapbox.com/ios-sdk/api/'
diff --git a/platform/macos/Mapbox-macOS-SDK-symbols.podspec b/platform/macos/Mapbox-macOS-SDK-symbols.podspec
index 7083f70961..6de7f829a3 100644
--- a/platform/macos/Mapbox-macOS-SDK-symbols.podspec
+++ b/platform/macos/Mapbox-macOS-SDK-symbols.podspec
@@ -1,24 +1,26 @@
Pod::Spec.new do |m|
- m.name = 'Mapbox-macOS-SDK'
- m.version = '0.3.0-rc.1-symbols'
+ version = '0.3.0-rc.1'
+
+ m.name = 'Mapbox-macOS-SDK-symbols'
+ m.version = "#{version}-symbols"
m.summary = 'Open-source, interactive, fully customizable vector maps.'
m.description = 'Interactive, fully customizable vector maps with tight platform integration and high-performance OpenGL rendering.'
m.homepage = 'https://mapbox.github.io/mapbox-gl-native/macos/'
m.license = { :type => 'BSD', :file => 'LICENSE.md' }
m.author = { 'Mapbox' => 'mobile@mapbox.com' }
- m.screenshot = "https://raw.githubusercontent.com/mapbox/mapbox-gl-native/macos-#{m.version.to_s}/platform/macos/docs/img/screenshot.jpg"
+ m.screenshot = "https://mapbox.github.io/mapbox-gl-native/macos/#{version}/img/screenshot.jpg"
m.social_media_url = 'https://twitter.com/mapbox'
m.documentation_url = 'https://mapbox.github.io/mapbox-gl-native/macos/'
m.source = {
- :http => "https://github.com/mapbox/mapbox-gl-native/releases/download/macos-v#{m.version.to_s}/mapbox-macos-sdk-#{m.version.to_s}.zip",
+ :http => "https://github.com/mapbox/mapbox-gl-native/releases/download/macos-v#{version}/mapbox-macos-sdk-#{m.version.to_s}.zip",
:flatten => true
}
- m.platform = :macos
- m.macos.deployment_target = '10.10'
+ m.platform = :osx
+ m.osx.deployment_target = '10.10'
m.requires_arc = true
diff --git a/platform/macos/Mapbox-macOS-SDK.podspec b/platform/macos/Mapbox-macOS-SDK.podspec
index 9a3b98b7a0..03ef0eabe7 100644
--- a/platform/macos/Mapbox-macOS-SDK.podspec
+++ b/platform/macos/Mapbox-macOS-SDK.podspec
@@ -1,24 +1,26 @@
Pod::Spec.new do |m|
+ version = '0.3.0-rc.1'
+
m.name = 'Mapbox-macOS-SDK'
- m.version = '0.3.0-rc.1'
+ m.version = version
m.summary = 'Open-source, interactive, fully customizable vector maps.'
m.description = 'Interactive, fully customizable vector maps with tight platform integration and high-performance OpenGL rendering.'
m.homepage = 'https://mapbox.github.io/mapbox-gl-native/macos/'
m.license = { :type => 'BSD', :file => 'LICENSE.md' }
m.author = { 'Mapbox' => 'mobile@mapbox.com' }
- m.screenshot = "https://raw.githubusercontent.com/mapbox/mapbox-gl-native/macos-#{m.version.to_s}/platform/macos/docs/img/screenshot.jpg"
+ m.screenshot = "https://mapbox.github.io/mapbox-gl-native/macos/#{version}/img/screenshot.jpg"
m.social_media_url = 'https://twitter.com/mapbox'
m.documentation_url = 'https://mapbox.github.io/mapbox-gl-native/macos/'
m.source = {
- :http => "https://github.com/mapbox/mapbox-gl-native/releases/download/macos-v#{m.version.to_s}/mapbox-macos-sdk-#{m.version.to_s}.zip",
+ :http => "https://github.com/mapbox/mapbox-gl-native/releases/download/macos-v#{version}/mapbox-macos-sdk-#{m.version.to_s}.zip",
:flatten => true
}
- m.platform = :macos
- m.macos.deployment_target = '10.10'
+ m.platform = :osx
+ m.osx.deployment_target = '10.10'
m.requires_arc = true
diff --git a/platform/macos/README.md b/platform/macos/README.md
index 13cb04eb52..aea5ba0d6a 100644
--- a/platform/macos/README.md
+++ b/platform/macos/README.md
@@ -10,15 +10,15 @@ Put interactive, scalable world maps into your native Cocoa application with the
* A well-designed, fully documented API helps you stay productive.
* Develop across [multiple platforms](../../README.md), including [iOS](../ios/README.md), using the same styles and similar APIs.
+![](docs/img/screenshot.jpg)
+
The Mapbox macOS SDK is compatible with macOS 10.10.0 and above for Cocoa applications developed in Objective-C, Swift, Interface Builder, or AppleScript. For hybrid applications, consider [Mapbox GL JS](https://github.com/mapbox/mapbox-gl-js/).
* [Integrate the Mapbox macOS SDK into your application](INSTALL.md)
* [Contribute to the Mapbox macOS SDK](DEVELOPING.md)
-* [Mapbox macOS SDK reference documentation](https://mapbox.github.io/mapbox-gl-native/macos/api/)
+* [Mapbox macOS SDK reference documentation](https://mapbox.github.io/mapbox-gl-native/macos/)
* [See example styles designed in Mapbox Studio](https://www.mapbox.com/gallery/)
* [Hand-authoring a macOS SDK–compatible style](https://www.mapbox.com/mapbox-gl-style-spec/)
* [Mapbox Vector Tile Specification](https://www.mapbox.com/developers/vector-tiles/)
-![](docs/img/screenshot.jpg)
-
Mapbox does not officially support the Mapbox macOS SDK to the same extent as the Mapbox iOS SDK; however, bug reports and pull requests are certainly welcome.
diff --git a/platform/macos/docs/pod-README.md b/platform/macos/docs/pod-README.md
index f82a41e6d7..6d45a68c34 100644
--- a/platform/macos/docs/pod-README.md
+++ b/platform/macos/docs/pod-README.md
@@ -8,21 +8,30 @@ Put interactive, scalable world maps into your native Cocoa application with the
* A well-designed, fully documented API helps you stay productive.
* Develop across [multiple platforms](https://www.mapbox.com/maps/), including [iOS](https://www.mapbox.com/ios-sdk/), using the same styles and similar APIs.
-The Mapbox macOS SDK is compatible with macOS 10.10.0 and above for Cocoa applications developed in Objective-C, Swift, Interface Builder, or AppleScript. For hybrid applications, consider [Mapbox GL JS](https://www.mapbox.com/mapbox-gl-js/).
-
![](https://raw.githubusercontent.com/mapbox/mapbox-gl-native/master/platform/macos/docs/img/screenshot.jpg)
+The Mapbox macOS SDK is compatible with macOS 10.10.0 and above for Cocoa applications developed in Objective-C, Swift, Interface Builder, or AppleScript. For hybrid applications, consider [Mapbox GL JS](https://www.mapbox.com/mapbox-gl-js/).
+
Mapbox macOS SDK releases are [available on GitHub](https://github.com/mapbox/mapbox-gl-native/releases/) – look for the releases that begin with “macos-”. You can also integrate the Mapbox macOS SDK into your application using CocoaPods.
## Installation
-1. Open the project editor, select your application target, then go to the General tab. Drag Mapbox.framework from the `dynamic` folder into the “Embedded Binaries” section. (Don’t drag it into the “Linked Frameworks and Libraries” section; Xcode will add it there automatically.) In the sheet that appears, make sure “Copy items if needed” is checked, then click Finish.
+1. Open the project editor, select your application target, then go to the General tab. Drag Mapbox.framework into the “Embedded Binaries” section. (Don’t drag it into the “Linked Frameworks and Libraries” section; Xcode will add it there automatically.) In the sheet that appears, make sure “Copy items if needed” is checked, then click Finish.
-1. Mapbox vector tiles require a Mapbox account and API access token. In the project editor, select the application target, then go to the Info tab. Under the “Custom macOS Target Properties” section, set `MGLMapboxAccessToken` to your access token. You can obtain an access token from the [Mapbox account page](https://www.mapbox.com/studio/account/tokens/).
+1. Mapbox vector tiles require a Mapbox account and API access token. In the project editor, select the application target, then go to the Info tab. Under the “Custom macOS Application Target Properties” section, set `MGLMapboxAccessToken` to your access token. You can obtain an access token from the [Mapbox account page](https://www.mapbox.com/studio/account/tokens/).
## Usage
-In a storyboard or XIB, add a view to your view controller. (Drag Custom View from the Object library to the View Controller scene on the Interface Builder canvas.) In the Identity inspector, set the view’s custom class to `MGLMapView`. If you need to manipulate the map view programmatically:
+In a storyboard or XIB:
+
+1. Add a view to your view controller or window. (Drag Custom View from the Object library to the View Controller scene on the Interface Builder canvas. In a XIB, drag it instead to the window on the canvas.)
+2. In the Identity inspector, set the view’s custom class to `MGLMapView`.
+3. MGLMapView needs to be layer-backed:
+ * You can make the window layer-backed by selecting the window and checking Full Size Content View in the Attributes inspector. This allows the map view to underlap the title bar and toolbar.
+ * Alternatively, if you don’t want the entire window to be layer-backed, you can make just the map view layer-backed by selecting it and checking its entry under the View Effects inspector’s Core Animation Layer section.
+4. Add a map feedback item to your Help menu. (Drag Menu Item from the Object library into Main Menu ‣ Help ‣ Menu.) Title it “Improve This Map” or similar, and connect it to the `giveFeedback:` action of First Responder.
+
+If you need to manipulate the map view programmatically:
1. Switch to the Assistant Editor.
1. Import the `Mapbox` module.