Readme: Add disclaimer and Chinese README (#40)

This commit is contained in:
Scirese 2023-01-11 08:12:02 +08:00 committed by GitHub
parent 848712e417
commit d9f656031d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 84 additions and 0 deletions

View File

@ -1,12 +1,36 @@
**English** | [中文](README_CN.md)
# KernelSU
A Kernel based root solution for Android GKI.
## Before Reading
Now KernelSU supports old kernel under 5.10, but **THERE WILL NEVER** be a CI for old kernels, because they are not generic.
ANY ISSUES ABOUT HOW TO COMPILE A OLD KERNEL WILL NOT BE ANSWERED AND WILL BE CLOSED.
KernelSU is in a early development stage and you should not put it into production enviroment. KernelSU developers will not be responsible for any of your losses.
If you face any issue, feel free to open a [issue](https://github.com/tiann/KernelSU/issues) and tell us about it!
## Compatibility State
Now KernelSU will work on these version of kernels without any modification
- `5.15`
- `5.10`
- `5.4`
- `4.19`
If you confirm KernelSU works on other version, open a [issue](https://github.com/tiann/KernelSU/issues) tell us about it!
## Usage
1. Flash a custom kernel with KernelSU, you can build it yourself or [download it from CI](https://github.com/tiann/KernelSU/actions/workflows/build-kernel.yml).
2. Install Manager App and enjoy :)
For old kernels under 5.10, you must build custom kernels by yourself.
## Build
### Build GKI Kernel

60
README_CN.md Normal file
View File

@ -0,0 +1,60 @@
[English](README.md) | **中文**
# KernelSU
一个基于内核, 为安卓 GKI 准备的 root 方案.
## 阅读之前
现在 KernelSU 支持 5.10 以下的旧内核, 但**永远不会**有旧内核的CI, 因为它们不是通用的.
**任何关于如何编译旧内核的问题都不会得到任何答复并将被关闭.**
KernelSU 还处于早期开发阶段, 你不应该生产环境中使用它. KernelSU 的开发者将不对你的任何损失负责.
如果你遇到任何问题, 请打开 [issue](https://github.com/tiann/KernelSU/issues) 告诉我们! (最好使用英语)
## 兼容状态
现在, KernelSU 可以在这些版本的内核上正常工作, 不需要任何修改.
- `5.15`
- `5.10`
- `5.4`
- `4.19`
如果你确认 KernelSU 能在其他版本上工作, 请打开一个 [issue](https://github.com/tiann/KernelSU/issues) 告诉我们!
## 使用方法
1. 用 KernelSU 刷新一个自定义的内核, 你可以自己构建它或者[从 CI 下载](https://github.com/tiann/KernelSU/actions/workflows/build-kernel.yml).
2. 安装管理器应用, 然后享受吧 :)
对于 5.10 以下的旧内核, 你必须自己构建.
## 构建
### 构建GKI内核
1. 首先下载 GKI 源代码, 你可以参考[ GKI 构建说明](https://source.android.com/docs/setup/build/building-kernels)
2. cd `< GKI 内核源代码目录 >`.
3. `curl -LSs "https://raw.githubusercontent.com/tiann/KernelSU/main/kernel/setup.sh" | bash -`.
4. 构建内核.
### 构建管理器应用
Android Studio / Gradle
### 讨论
[@KernelSU](https://t.me/KernelSU)
## 许可证
[GPL-3](http://www.gnu.org/copyleft/gpl.html)
## 鸣谢
- [kernel-assisted-superuser](https://git.zx2c4.com/kernel-assisted-superuser/about/): KernelSU 的灵感.
- [true](https://github.com/brevent/genuine/): apk v2 签名验证.
- [Diamorphine](https://github.com/m0nad/Diamorphine): 一些rootkit技巧.
- [Magisk](https://github.com/topjohnwu/Magisk): sepolicy 的实现.