README.md

August 3, 2026 · View on GitHub

中文 | 日本語

Overview

Please go to SiYuan issues to report issues/consult discussions
Code contributions are welcome

Construction guide

Refer to SiYuan Development Guide to compile the kernel
Copy the resource files and package it in app/src/main/assets/app.zip
- appearance
- guide
- stage
- changelogs

Directory structure reference:

project-tree

app.zip

About Multi-Channel Software Distribution

If you are building your program using the Android Studio method of going to 【Build】,【Generate Signed Bundle APK...】, you only need to modify the siyuanVersionName and siyuanVersionCode within the build.gradle file at the project level. After making the changes, you can directly package the app and ignore the following content.

Steps

The following content is only necessary when building via the command line console:

When building using the command line console, you not only need to modify the siyuanVersionName and siyuanVersionCode within the build.gradle file at the project level, but you also need to perform the following steps:

Copy the signings.templates.gradle file and rename it to signings.gradle.
Configure the related information in signings.gradle.
Use the command line to navigate to the root directory of the project and execute the following
```
# windows
.\gradlew clean buildReleaseTask
# linux
gradle clean buildReleaseTask
```
The naming convention is as follows:
```
assemble/bundle  Googleplay  Debug/Release
```
assemble generates APKs bundle generates AABs Googleplay is the name of the channel package; refer to the productFlavors {} configuration in flavors.gradle for the specified location Debug/Release stands for Test version/Official version
After the execution is complete, you can find the generated program at the following location
```
siyuan-android\app\build-release\siyuan-${versionName}-all
```