Update DEVELOPING.md (#886)

This commit is contained in:
Bart Louwers
2023-03-14 10:57:24 +01:00
committed by GitHub
parent 5efed925b0
commit d7d00b4dfe

View File

@@ -1,14 +1,5 @@
# Developing
This is been rewritten to include:
- How to build for the platforms we support.
- Acceptance criteria for code contributions (style, static asserts)
- How to run the unit tests.
- How to run the benchmarks.
- How to rebaseline baselines metrics.
- How to use GL Native as a 3rd party library in your project.
## Render Tests
To check that the output of the rendering is correct, we compare actual rendered PNGs for simple styles with expected PNGs. The content of the tests is stored in the MapLibre GL JS submodule which means that GL JS and Native are in fact quasi pixel-identical in their rendering.
@@ -71,7 +62,7 @@ The render test results are summarized in a HTML website located next to the man
# MapLibre & C++
MapLibre makes use of a common set of C++ files for iOS, macOS, Android, Linux & QT. See [`platform/default/src/mbgl/`](`platform/default/src/mbgl/`),
MapLibre makes use of a common set of C++ files for iOS, macOS, Android, Linux & Qt. See [`platform/default/src/mbgl/`](`platform/default/src/mbgl/`),
or any of the platform make files:
* [`platform/android/android.cmake`](platform/android/android.cmake)
@@ -170,4 +161,5 @@ autoload -Uz compinit && compinit
```
### Kotlin and Java compatibility
We are moving the Android SDK to Kotlin, which is backward compatible with Java, but if you need a Java version of the Android SDK there is a `before-kotlin-port` tag available.