diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 46 |
1 files changed, 18 insertions, 28 deletions
@@ -1,42 +1,32 @@ # Mapbox GL Native +[](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) [](https://codecov.io/gh/mapbox/mapbox-gl-native) + A library for embedding interactive, customizable vector maps into native applications on multiple platforms. It takes stylesheets that conform to the [Mapbox Style Specification](https://github.com/mapbox/mapbox-gl-style-spec/), applies them to vector tiles that conform to the [Mapbox Vector Tile Specification](https://github.com/mapbox/vector-tile-spec), -and renders them using OpenGL. [Mapbox GL JS](https://github.com/mapbox/mapbox-gl-js) is the WebGL-based counterpart, +and renders them using OpenGL or Metal. [Mapbox GL JS](https://github.com/mapbox/mapbox-gl-js) is the WebGL-based counterpart, designed for use on the Web. -| SDK | Languages | Build status | -| --------------------------------------------------- | ---------------------------------- | ---------------------------------------- | -| Mapbox GL Native Core | C++14 | [](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) [](https://codecov.io/gh/mapbox/mapbox-gl-native) | -| [Mapbox Maps SDK for Android](../platform/android/) | Java | [](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) | -| [Mapbox Maps SDK for iOS](../platform/ios/) | Objective-C or Swift | [](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) | -| [Mapbox Maps SDK for macOS](../platform/macos/) | Objective-C, Swift, or AppleScript | [](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) | -| [node-mapbox-gl-native](../platform/node/) | Node.js | [](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) | -| [Mapbox Maps SDK for Qt](../platform/qt) | C++03 | [](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) [](https://ci.appveyor.com/project/Mapbox/mapbox-gl-native) | +## Developing -[Additional Mapbox GL Native–based libraries](https://wiki.openstreetmap.org/wiki/Mapbox_GL#Libraries) for **hybrid applications** are developed outside of this repository. If your platform or hybrid application framework isn’t listed there, consider embedding [Mapbox GL JS](https://github.com/mapbox/mapbox-gl-js) using the standard Web capabilities on your platform. +We use [CMake](https://cmake.org/cmake/help/latest/) to build Mapbox GL Native +to various platforms, including Linux, Android, iOS, macOS and Windows. -## License +The following command, executed from the root of this repository tree, will build +Mapbox GL Native targeting your host architecture given that you have all the +dependencies installed. -Mapbox GL Native is licensed under the [3-Clause BSD license](../LICENSE.md). - -## Developing +``` +$ git update submodules --init --recursive +$ cmake . -B build +$ cmake --build build +``` -The `next` directory contains the next generation buildsystem for Mapbox GL Native, based solely on CMake with the -goal of minimizing the use of scripts, increase portability and support building Mapbox GL Native as a subdirectory -of another CMake project. This new buildsystem is also designed to build offline, making use of pre-installed and -vendorized dependencies. When using the build bot docker image, the build should produce the exact same results as -the bots, making it a hermetically sealed build for Linux, Qt and Android. +Read more about how to build Mapbox GL Native for your platform [here](DEVELOPING.md). -### Building and running tests +## License -The following command, executed from the root of this repository tree, will build Mapbox GL Native targeting your -host architecture given that you have all the dependencies installed. +Mapbox GL Native is licensed under the [2-Clause BSD license](LICENSE.md). The licenses of its dependencies are tracked via [FOSSA](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmapbox%2Fmapbox-gl-native): -``` -$ mkdir build && cd build -$ cmake .. -$ make -j8 -$ make test ARGS=-V -``` +[](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmapbox%2Fmapbox-gl-native) |