README.md

Bitkit Core Android

Android library for Bitkit Core bindings.

Installation

GitHub Packages

1. Setup your GitHub credentials

Create a GitHub PAT (Personal Access Token):

• Go to GitHub → Settings → Developer settings → Personal access tokens → Tokens (classic)
• Generate new token with scopes: read:packages (and repo if package/repo is private)
• Copy the token once and use it in the next steps:

Set env vars:

export GITHUB_ACTOR="your_github_username"
export GITHUB_TOKEN="your_pat_with_read:packages"

Or add to ~/.gradle/gradle.properties:

gpr.user=<your_github_username>
gpr.key=<your_pat_with_read:packages>

2. Add the GitHub Packages repository

// settings.gradle.kts
dependencyResolutionManagement {
  repositories {
    google()
    mavenCentral()
    maven {
      url = uri("https://maven.pkg.github.com/synonymdev/bitkit-core")
      credentials {
          username = System.getenv("GITHUB_ACTOR") ?: providers.gradleProperty("gpr.user").orNull
          password = System.getenv("GITHUB_TOKEN") ?: providers.gradleProperty("gpr.key").orNull
      }
    }
  }
}

3. Declare the dependency

// app/build.gradle.kts
dependencies {
  implementation("com.synonym:bitkit-core-android:<VERSION>")
  // example:
  // implementation("com.synonym:bitkit-core-android:0.1.0")
}

Maven Local (development)

// settings.gradle.kts
dependencyResolutionManagement {
  repositories {
    mavenLocal()
    // others
  }
}

// build.gradle.kts
dependencies {
  implementation("com.synonym:bitkit-core-android:<LOCAL_VERSION>")
}

---

Publishing

⚠️ Reminder: Versions are immutable, bump for each publish.

GitHub Actions

Create a GitHub Release with a new tag like v0.1.0. The workflow gradle-publish.yml will publish that version.

Terminal

./build_android.sh
cd ./bindings/android
./gradlew publish -Pversion=0.1.0

Run ./build_android.sh before any direct Gradle publish so jniLibs is regenerated with native debug metadata and 16 KB page-size alignment.