summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMinh Nguyễn <mxn@1ec5.org>2016-05-09 16:03:51 -0700
committerMinh Nguyễn <mxn@1ec5.org>2016-05-10 09:59:04 -0700
commita025d8327afeea74a9a1a8c9a9a237e21af917bb (patch)
tree188e6da2b178a8fe592c595de26a527e27ddcaa6
parent5616cd2bb165bd50bed85ae58624642975fd1ba0 (diff)
downloadqtlocation-mapboxgl-a025d8327afeea74a9a1a8c9a9a237e21af917bb.tar.gz
[osx] Added changelog
Also updated developer installation guide to refer to the new make rule for generating documentation.
-rw-r--r--platform/osx/CHANGELOG.md5
-rw-r--r--platform/osx/INSTALL.md2
2 files changed, 6 insertions, 1 deletions
diff --git a/platform/osx/CHANGELOG.md b/platform/osx/CHANGELOG.md
new file mode 100644
index 0000000000..b39dd5619d
--- /dev/null
+++ b/platform/osx/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog for Mapbox OS X SDK
+
+## master
+
+* This version of the Mapbox OS X SDK roughly corresponds to version 3.2.2 of the Mapbox iOS SDK. The two SDKs have very similar feature sets. The main difference is the lack of user location tracking. Some APIs have been adapted to OS X conventions, particularly the use of NSPopover for callout views.
diff --git a/platform/osx/INSTALL.md b/platform/osx/INSTALL.md
index eaca3a2ba3..3787873d9c 100644
--- a/platform/osx/INSTALL.md
+++ b/platform/osx/INSTALL.md
@@ -45,4 +45,4 @@ class ViewController: NSViewController {
}
```
-The [Mapbox iOS SDK’s API documentation](https://www.mapbox.com/ios-sdk/api/) applies to the Mapbox OS X SDK with few differences, mostly around unimplemented features like user location tracking.
+Run `make xdocument` to generate complete API documentation. The [Mapbox iOS SDK](https://www.mapbox.com/ios-sdk/)’s [API documentation](https://www.mapbox.com/ios-sdk/api/) and [online examples](https://www.mapbox.com/ios-sdk/examples/) apply to the Mapbox OS X SDK with few differences, mostly around unimplemented features like user location tracking.