diff --git a/README.md b/README.md index ea089e88..ae76907d 100644 --- a/README.md +++ b/README.md @@ -46,3 +46,19 @@ Feature of [Clash.Meta](https://github.com/MetaCubeX/Clash.Meta) ```bash ./gradlew app:assembleMeta-AlphaRelease ``` + +### Kernel Contribution + +- CMFA uses the kernel from `android-real` branch under `MetaCubeX/Clash.Meta`, which is a merge of the main `Alpha` branch and `android-open`. + - If you want to contribute to the kernel, make PRs to `Alpha` branch of the Meta kernel repository. + - If you want to contribute Android-specific patches to the kernel, make PRs to `android-open` branch of the Meta kernel repository. + +### Project Maintainance + +- When `MetaCubeX/Clash.Meta` kernel is updated to a new version, the `Update Dependencies` actions in this repo will be triggered automatically. + - It will pull the new version of the meta kernel, update all the golang dependencies, and create a PR without manual intervention. + - If there is any compile error in PR, you need to fix it before merging. Alternatively, you may merge the PR directly. +- Manually triggering `Build Pre-Release` actions will automatically compile and publish a `PreRelease` version. +- Manually triggering `Build Release` actions will automatically compile, tag and publish a `Release` version. + - There is an option `Auto bump project version` in trigger widget. If this option is checked and triggered, the `versionName` and `versionCode` in `build.gradle.kts` will be bumped first, then do the common build release process. + - This option is intended for quickly update and release a new version online, without pulling the repository locally and work around by manual.