letro/letro-android
1
0
Fork 0
Code Issues Pull Requests Actions 6 Packages Projects Releases Wiki Activity

Improve onboarding docs: (#4578)

Browse Source 
- Make clear the contributing guide for Synapse is for a whole different project, update the link.
- Also clarify building the SDK locally is not mandatory.
This commit is contained in:
Jorge Martin Espinosa
2025-04-14 10:30:01 +02:00
committed by GitHub
parent c64b195496
commit f0a0b5683e
2 changed files with 14 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/_developer_onboarding.md
View File

@@ -10,7 +10,7 @@
* [Sync](#sync)
* [Rust SDK](#rust-sdk)
* [Matrix Rust Component Kotlin](#matrix-rust-component-kotlin)
* [Build the SDK locally](#build-the-sdk-locally)
* [Building the SDK locally](#building-the-sdk-locally)
* [The Android project](#the-android-project)
* [Application](#application)
* [Jetpack Compose](#jetpack-compose)
@@ -107,7 +107,7 @@ This is the goal of https://github.com/matrix-org/matrix-rust-components-kotlin.
This repository is used for distributing kotlin releases of the Matrix Rust SDK.
It'll provide the corresponding aar and also publish them on maven.
Most of the time you want to use the releases made on maven with gradle:
Most of the time **you want to use the releases made on maven with gradle**:
```groovy
implementation("org.matrix.rustcomponents:sdk-android:latest-version")
@@ -115,7 +115,9 @@ implementation("org.matrix.rustcomponents:sdk-android:latest-version")
You can also have access to the aars through the [release](https://github.com/matrix-org/matrix-rust-components-kotlin/releases) page.
#### Build the SDK locally
#### Building the SDK locally
If you want to make changes to the SDK or test them before integrating it with your codebase, you can build the SDK locally too.
Prerequisites:
* Install the Android NDK (Native Development Kit). To do this from within