Skip to content

GUIDE.md

Latest commit

 

History

History
68 lines (45 loc) · 1.99 KB

GUIDE.md

File metadata and controls

68 lines (45 loc) · 1.99 KB
Doki logo

Doki Building Guide

Table of contents
  1. How does this repository work?
  2. How can users get Doki without coding knowledge?
  3. How can developers / contributors build Doki locally?
  4. How to build Doki with GitHub Codespaces (pre-installed environment)?
  5. License
  6. Need help ?

How it works

TODO

Quick Guide

Tip

Download the APK from the repository's Releases page on your phone and tap it to install.

Important

check.yml may trigger builds automatically when upstream changes are detected — check Releases or Actions artifacts for new APKs.

Caution

You may need to allow "Install unknown apps" for your browser or file manager in your device settings before installing.

Local build

If you prefer a local build:

./gradlew assembleRelease

Warning

Signed CI builds require secrets: KEYSTORE_BASE64, KEYSTORE_PASSWORD, KEY_ALIAS, KEY_PASSWORD. Maintainers: add these in your fork's Settings → Secrets and variables → Actions.

Build with GitHub Codespaces

TODO

License

GNU GPLv3 Image

You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.

Need help ?

Questions? Ask for one small expansion (enable Actions steps, screenshots, or exact artifact names).