5616cd2bb1
Added a target, script, and make rule for generating OS X SDK documentation with jazzy, along with a docset cover page. Switched the umbrella header from framework header syntax to user header syntax so SourceKit can find all the headers. Fixes #4871.
1.4 KiB
Mapbox OS X SDK
The Mapbox OS X SDK is an open-source framework for embedding interactive map views with scalable, customizable vector maps into Cocoa applications on OS X 10.10.0 and above using Objective-C, Swift, or Interface Builder. It takes stylesheets that conform to the Mapbox GL Style Specification, applies them to vector tiles that conform to the Mapbox Vector Tile Specification, and renders them using OpenGL.
For setup information, consult the README.md that comes with this documentation. The Mapbox iOS SDK’s API documentation and online examples apply to the Mapbox OS X SDK with few differences, mostly around unimplemented features like user location tracking. A full changelog is also available.
Mapbox does not officially support the OS X SDK to the same extent as the iOS SDK; however, bug reports and pull requests are certainly welcome.