Grimoire
Development

Overview

Build Grimoire from source and contribute.

Grimoire is a native Android app written in Kotlin. This section covers building it from source, the project architecture, and how to contribute.

Toolchain

  • Android Studio with Android Gradle Plugin 9.2.1
  • Kotlin 2.2 (KSP 2.2.10-2.0.2)
  • Java 11

Build

./gradlew :app:installDebug      # build + install a debug build
./gradlew assembleRelease        # build a release APK

What's here

  • Project structure — module layout (coming soon).
  • Coding conventions — style and patterns (coming soon).
  • Contributing — workflow and PR process (coming soon).

On this page