mirror of
https://github.com/meshtastic/Meshtastic-Android.git
synced 2026-10-03 00:54:34 -04:00
docs: publish channels: root v2.8.2 api
This commit is contained in:
1 parent
d6fd462320
commit
dc63ed48e6
3747 files changed
+355144
-78365
No files matched your search
@@ -13,11 +13,11 @@ Repository layout, namespacing conventions, and build system overview.
|
||||
|
||||
## Repository Structure
|
||||
|
||||
```
|
||||
```text
|
||||
Meshtastic-Android/
|
||||
├── androidApp/ # Android application module
|
||||
│ ├── src/main/ # Shared Android code
|
||||
│ ├── src/google/ # Google Play flavor (Gemini, proprietary)
|
||||
│ ├── src/google/ # Google Play flavor (proprietary Google integrations — Gemini, Maps, Play services)
|
||||
│ └── src/fdroid/ # F-Droid flavor (FOSS-only)
|
||||
├── desktopApp/ # Desktop JVM application
|
||||
├── feature/ # Feature modules (KMP)
|
||||
@@ -25,14 +25,14 @@ Meshtastic-Android/
|
||||
│ ├── messaging/
|
||||
│ ├── connections/
|
||||
│ ├── map/
|
||||
│ ├── map-maplibre/
|
||||
│ ├── node/
|
||||
│ ├── settings/
|
||||
│ ├── firmware/
|
||||
│ ├── docs/
|
||||
│ ├── wifi-provision/
|
||||
│ ├── widget/
|
||||
│ ├── discovery/
|
||||
│ └── car/
|
||||
│ └── discovery/
|
||||
├── core/ # Core infrastructure modules (KMP)
|
||||
│ ├── barcode/
|
||||
│ ├── ble/
|
||||
@@ -72,7 +72,7 @@ Meshtastic-Android/
|
||||
## Namespacing Convention
|
||||
|
||||
All Kotlin packages follow the pattern:
|
||||
```
|
||||
```text
|
||||
org.meshtastic.{layer}.{module}.{subpackage}
|
||||
```
|
||||
|
||||
@@ -93,13 +93,23 @@ All build files use Kotlin DSL (`.gradle.kts`). Configuration:
|
||||
|
||||
### Convention Plugins
|
||||
|
||||
Located in `build-logic/convention/src/main/kotlin/`:
|
||||
Located in `build-logic/convention/src/main/kotlin/`. The full set is registered in
|
||||
`build-logic/convention/build.gradle.kts`; these are the ones a module build applies most often:
|
||||
|
||||
Plugin | Purpose |
|
||||
--------|---------|
|
||||
`meshtastic.kmp.feature` | Standard feature module setup |
|
||||
`meshtastic.kmp.library` | Shared KMP library module |
|
||||
`meshtastic.kmp.library.compose` | KMP library that also ships Compose UI |
|
||||
`meshtastic.kmp.jvm.android` | JVM + Android target configuration |
|
||||
`meshtastic.koin` | Koin Annotations + K2 compiler plugin |
|
||||
`meshtastic.kotlinx.serialization` | Serialization plugin setup |
|
||||
`meshtastic.android.room` | Room KMP setup and schema location |
|
||||
`meshtastic.android.screenshot` | Compose Preview screenshot testing |
|
||||
|
||||
The rest cover the application and library variants, lint, detekt, spotless, Dokka, Kover,
|
||||
AboutLibraries, analytics, secrets, the docs tasks and the root aggregate — read the `register(…)`
|
||||
block rather than assuming a plugin does or does not exist.
|
||||
|
||||
### Build Variants (Android)
|
||||
|
||||
@@ -110,7 +120,7 @@ Located in `build-logic/convention/src/main/kotlin/`:
|
||||
|
||||
### Key Gradle Tasks
|
||||
|
||||
```bash
|
||||
```shell
|
||||
# Compile check across all KMP targets
|
||||
./gradlew kmpSmokeCompile
|
||||
|
||||
@@ -147,9 +157,6 @@ Key dependencies in `gradle/libs.versions.toml`:
|
||||
Networking | Ktor |
|
||||
Markdown | multiplatform-markdown-renderer |
|
||||
Testing | kotlin-test, compose-ui-test |
|
||||
|
||||
---
|
||||
|
||||
</pre>
|
||||
</body>
|
||||
</html>
|
||||
Reference in new issue
Block a user