Add getting started guide for maplibre gl native for android (#939)
Co-authored-by: Loc Nguyen <loc.nguyen@aensmart.com> Co-authored-by: Bart Louwers <bart.louwers@gmail.com> Co-authored-by: Bart Louwers <bart@emeel.net>
This commit is contained in:
5
platform/android/MapboxGLAndroidSDK/README.md
Normal file
5
platform/android/MapboxGLAndroidSDK/README.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# Module MapLibre GL Native for Android
|
||||
|
||||
This is the MapLibre GL Native API for Android doccumentation.
|
||||
|
||||
Visit [https://maplibre.org/maplibre-gl-native/docs/book/android/getting-started-guide.html](https://maplibre.org/maplibre-gl-native/docs/book/android/getting-started-guide.html) to view the Getting Started Guide for MapLibre GL Native for Android.
|
||||
@@ -1,3 +1,5 @@
|
||||
import org.jetbrains.dokka.gradle.DokkaTask
|
||||
|
||||
plugins {
|
||||
id 'org.jmailen.kotlinter'
|
||||
id 'org.jetbrains.dokka' version '1.7.20'
|
||||
@@ -32,6 +34,17 @@ dependencies {
|
||||
androidTestImplementation dependenciesList.testRules
|
||||
}
|
||||
|
||||
tasks.withType(DokkaTask.class) {
|
||||
moduleName.set("MapLibre GL Native for Android")
|
||||
|
||||
dokkaSourceSets {
|
||||
|
||||
configureEach {
|
||||
includes.from("README.md")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
android {
|
||||
compileSdkVersion androidVersions.compileSdkVersion
|
||||
buildToolsVersion androidSdkVersions.buildToolsVersion
|
||||
|
||||
@@ -6,28 +6,7 @@ MapLibre GL Native for Android is a library for embedding interactive map views
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. Add bintray Maven repositories to your `build.gradle` at project level so that you can access MapLibre packages for Android:
|
||||
|
||||
```gradle
|
||||
allprojects {
|
||||
repositories {
|
||||
...
|
||||
mavenCentral()
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
2. Add the library as a dependency into your module build.gradle
|
||||
|
||||
```gradle
|
||||
dependencies {
|
||||
...
|
||||
implementation 'org.maplibre.gl:android-sdk:<version>'
|
||||
...
|
||||
}
|
||||
```
|
||||
|
||||
3. Sync Gradle and rebuild your app.
|
||||
Visit [https://maplibre.org/maplibre-gl-native/docs/book/android/getting-started-guide.html](https://maplibre.org/maplibre-gl-native/docs/book/android/getting-started-guide.html) to view the Getting Started Guide for MapLibre GL Native for Android.
|
||||
|
||||
## Documentation
|
||||
|
||||
|
||||
Reference in New Issue
Block a user