Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RGB-Tools/rgb-lib-kotlin
https://github.com/RGB-Tools/rgb-lib-kotlin
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/RGB-Tools/rgb-lib-kotlin
- Owner: RGB-Tools
- License: mit
- Created: 2022-08-29T14:12:18.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-29T15:17:29.000Z (4 months ago)
- Last Synced: 2024-08-29T17:00:06.916Z (4 months ago)
- Language: Dockerfile
- Size: 110 KB
- Stars: 8
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rgb-protocol - RGB Lib Kotlin bindings
README
# RGB Lib Kotlin bindings
This project builds an Android library, `rgb-lib-android`, for the [rgb-lib]
Rust library, which is included as a git submodule. The bindings are created by
the [rgb-lib-uniffi] project, which is located inside the rgb-lib submodule.
## Usage
To use the Kotlin library add the following to your project gradle dependencies:
```groovy
repositories {
mavenCentral()
}
dependencies {
implementation 'org.rgbtools:rgb-lib-android:'
}
```
## Contributing
### Build
#### In docker
In order to build the project, clone it and run:
```bash
# Update the submodule
git submodule update --init
```
Then build the docker image:
```bash
# takes a long time and uses a lot of disk space
docker compose build
```
Finally start the build container (if your user or group IDs are not `1000`,
adjust the environment variables `MYUID` and `MYGID` in the
`docker-compose.yml` file accordingly):
```bash
# will mount the local directory into the docker container
docker compose up
```
#### Local
In order to build the project, setup the following environment variables:
- `ANDROID_SDK_ROOT` (e.g. `export ANDROID_SDK_ROOT=~/Android/Sdk`)
- `ANDROID_NDK_ROOT` (e.g. `export ANDROID_NDK_ROOT=$ANDROID_SDK_ROOT/ndk/25.`)
Then, clone this project and run:
```bash
# Update the submodule
git submodule update --init
# Add Android rust targets
rustup target add aarch64-linux-android
rustup target add armv7-linux-androideabi
rustup target add x86_64-linux-android
# Build the Android library
./gradlew :android:buildAndroidLib
```
### Publish
#### To local Maven repository
In order to publish the library to your local Maven repository:
```bash
./gradlew :android:publishToMavenLocal --exclude-task signMavenPublication
```
#### To Maven Central repository (project maintainers only)
Set your `~/.gradle/gradle.properties` signing key values and SONATYPE login
```properties
signingKey=
signingPassword=
signing.gnupg.keyName=
ossrhUsername=
ossrhPassword=
```
and then publish by running:
```shell
./gradlew :android:publishToSonatype closeAndReleaseSonatypeStagingRepository
```
[rgb-lib]: https://github.com/RGB-Tools/rgb-lib
[rgb-lib-uniffi]: https://github.com/RGB-Tools/rgb-lib/tree/master/bindings/uniffi