@@ -1,5 +1,5 @@
|
||||
# MapLibre Native Core Documentation
|
||||
|
||||
This is the documentation of the public C++ API of MapLibre Native Core. You would normally only use this API if you are a contributor to one of the platform specific APIs. If you want to intergrate use MapLibre Native in your project, you are better served by [documentation specific to your platform](https://maplibre.org/projects/maplibre-native/), unless you are interested in the internals of MapLibre Native.
|
||||
This is the documentation of the public C++ API of MapLibre Native Core. You would normally only use this API if you are a contributor to one of the platform specific APIs. If you want to integrate use MapLibre Native in your project, you are better served by [documentation specific to your platform](https://maplibre.org/projects/maplibre-native/), unless you are interested in the internals of MapLibre Native.
|
||||
|
||||
The source code can be found [on GitHub](https://github.com/maplibre/maplibre-native) (the `include` directory contains the public API).
|
||||
|
||||
@@ -39,7 +39,7 @@ All new code should be written in [Kotlin](https://kotlinlang.org/).
|
||||
|
||||
## Style Checking
|
||||
|
||||
To check Kotlin style, we use [ktlint](https://pinterest.github.io/ktlint/). This linter is based on the [official Kotlin coding conventions](https://kotlinlang.org/docs/coding-conventions.html). We intergrate with it using the [kotlinder](https://github.com/jeremymailen/kotlinter-gradle) Gradle plugin.
|
||||
To check Kotlin style, we use [ktlint](https://pinterest.github.io/ktlint/). This linter is based on the [official Kotlin coding conventions](https://kotlinlang.org/docs/coding-conventions.html). We integrate with it using the [kotlinder](https://github.com/jeremymailen/kotlinter-gradle) Gradle plugin.
|
||||
|
||||
To check the style of all Kotlin source files, use:
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
[Bazel](https://bazel.build/) is used for building on iOS.
|
||||
|
||||
You can generate an Xcode project thanks to [rules_xcodeproj](https://github.com/MobileNativeFoundation/rules_xcodeproj) intergration.
|
||||
You can generate an Xcode project thanks to [rules_xcodeproj](https://github.com/MobileNativeFoundation/rules_xcodeproj) integration.
|
||||
|
||||
You need to install [bazelisk](https://github.com/bazelbuild/bazelisk), which is a wrapper around Bazel which ensures that the version specified in `.bazelversion` is used.
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Release Policy
|
||||
|
||||
> [!NOTE]
|
||||
> The following release policiy applies specifically to MapLibre **Android** and MapLibre **iOS**.
|
||||
> The following release policy applies specifically to MapLibre **Android** and MapLibre **iOS**.
|
||||
|
||||
- We use [semantic versioning](https://semver.org/). Breaking changes will always result in a major release.
|
||||
- Despite having extensive tests in place, as a FOSS project we have limited QA testing capabilities. When major changes took place we may opt to put out a pre-release to let the community help with testing.
|
||||
|
||||
@@ -35,7 +35,7 @@ property: `background-color`, `line-width`, etc., with a second level of directo
|
||||
|
||||
The JSON files in this directory are the manifests (to be passed to render test CLI tool). This directory also contains many directories that store metrics used by the tests. Other files/directories include:
|
||||
|
||||
- `cache-style.db`, `cache-metrics.db`: pre-populated cache (SQLite database file) so the tests can run offline. You may need to update this database when you need a new resource available during test executation.
|
||||
- `cache-style.db`, `cache-metrics.db`: pre-populated cache (SQLite database file) so the tests can run offline. You may need to update this database when you need a new resource available during test execution.
|
||||
- `binary-size`: binary-size checks. Not used right now, see [#3379](https://github.com/maplibre/maplibre-native/issues/3379).
|
||||
- `expectations`: expectations for various platforms. E.g. `expectations/platform-android` is referenced by the `android-render-test-runner-metrics.json` manifest under its `expectation_paths` key.
|
||||
- `ignores`: contains JSON files with as key a test path and as value a reason why a test is ignored. For example:
|
||||
@@ -57,7 +57,7 @@ The JSON files in this directory are the manifests (to be passed to render test
|
||||
}
|
||||
```
|
||||
|
||||
#### `metrics/intergration`
|
||||
#### `metrics/integration`
|
||||
|
||||
- `data`, `geojson`, `glyphs`, `image`, `sprites`, `styles`, `tiles`, `tilesets`, `video`: various data used by the render tests.
|
||||
- `expression-tests`: tests that verify the behavior of [expressions](https://maplibre.org/maplibre-style-spec/expressions/) of the MapLibre Style Spec.
|
||||
|
||||
Reference in New Issue
Block a user