Skip to content

Latest commit

 

History

History
76 lines (49 loc) · 2.42 KB

Developer_Guide.md

File metadata and controls

76 lines (49 loc) · 2.42 KB

Developer Guide / 开发指南

This document describes the overview of this project for developers.

See also Build Instruction.

Last Update: 2024.02.25

Toolchain & Dependencies

This is a pure kotlin Android Application.

Gradle Version Catalogs is used in this project:

see libs.versions.toml for all the libraries and all gradle plugins.

Toolchain

  • Gradlew 8.5, requiring JDK 17
  • Android Gradle Plugin 8.2.2
  • Android SDK 34
  • kotlin for JVM(Android) 1.9.22

Libraries

Highlight:

  • Jetpack Compose 1.6.1
  • Jetpack Datastore 1.0.0
  • kotlinx.serialization
  • kotlinx.parcelize
  • koin as a lightweight Dependency Injection solution

See List of Libraries and Gradle Plugins in Use for details

Build Variant

only one flavor purpose and two default BuildType (debug/release), and all release shrinks and minifies.

Build Variant Note
stable for stable and LTS release
preview for preview release, package name suffix .preview
checkout for bug-locate and dev build of Github Action, package name suffix .checkout

before v4.0, we have more (like common as stable, ci for Github Action).

Project Structure

Gradle Module

Currently:

  • app(app/): all actual code of the Phonograph Plus
  • changelog-generator(tools/changelog-generator): for generating changelog from

Repository Structure

Except gradle's file ():

  • .github/: Github Action and templates
  • .idea/: Android Studio's config including code style config and run config
  • app/, tools/changelog-generator: Gradle Module
  • docs/: documents
  • scripts/: bash scripts for ci
  • fastlane/metadata/android/: F-droid metadata, like summary, screenshot, changelogs
  • version_catalog.json: containing the latest version information that Phonograph Plus would read at
  • startup
  • crowdin.yml: Crowdin configuration
  • LICENSE.txt: GPL licenses
  • ReleaseNote.toml: GitHub Action preview_release read this and post to Release Page

Source Code Structure of Phonograph Plus

TODO