summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThiago Marcos P. Santos <tmpsantos@gmail.com>2020-02-07 18:57:44 +0200
committerThiago Marcos P. Santos <tmpsantos@gmail.com>2020-02-07 20:12:44 +0200
commit97cab6365bd083d162544eb4bcae4ebd47a7ecae (patch)
treedd64791f07e0a111356c546069a500f930a1e896 /README.md
parent021e48f35e4812803ecaadb1ed262c83354b767e (diff)
downloadqtlocation-mapboxgl-97cab6365bd083d162544eb4bcae4ebd47a7ecae.tar.gz
[documentation] Updated README and DEVELOPING
To reflect changes in the buildsystem.
Diffstat (limited to 'README.md')
-rw-r--r--README.md48
1 files changed, 18 insertions, 30 deletions
diff --git a/README.md b/README.md
index 482919c393..2a8344676a 100644
--- a/README.md
+++ b/README.md
@@ -1,42 +1,30 @@
# Mapbox GL Native
+[![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) [![Coverage Status](https://codecov.io/gh/mapbox/mapbox-gl-native/branch/master/graph/badge.svg)](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 | [![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) [![Coverage Status](https://codecov.io/gh/mapbox/mapbox-gl-native/branch/master/graph/badge.svg)](https://codecov.io/gh/mapbox/mapbox-gl-native) |
-| [Mapbox Maps SDK for Android](../platform/android/) | Java | [![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) |
-| [Mapbox Maps SDK for iOS](../platform/ios/) | Objective-C or Swift | [![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) |
-| [Mapbox Maps SDK for macOS](../platform/macos/) | Objective-C, Swift, or AppleScript | [![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) |
-| [node-mapbox-gl-native](../platform/node/) | Node.js | [![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) |
-| [Mapbox Maps SDK for Qt](../platform/qt) | C++03 | [![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) [![AppVeyor CI build status](https://ci.appveyor.com/api/projects/status/3q12kbcooc6df8uc?svg=true)](https://ci.appveyor.com/project/Mapbox/mapbox-gl-native) |
-
-[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.
-
-## License
-
-Mapbox GL Native is licensed under the [3-Clause BSD license](../LICENSE.md).
+## [Developing](DEVELOPING.md)
-## Developing
+We use [CMake](https://cmake.org/cmake/help/latest/) to build Mapbox GL Native
+for various platforms, including Linux, Android, iOS, macOS and Windows. 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 and run the example app.
-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.
+```
+$ git update submodules --init --recursive
+$ cmake . -B build
+$ cmake --build build
+$ MAPBOX_ACCESS_TOKEN=my_access_token_here ./build/platform/glfw/mbgl-glfw
+```
-### 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
-```
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmapbox%2Fmapbox-gl-native.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmapbox%2Fmapbox-gl-native)