docs: simplify

This commit is contained in:
tiann
2023-01-28 09:33:03 +08:00
parent d41954b09c
commit 0dae6ebaee
2 changed files with 20 additions and 64 deletions

View File

@@ -2,54 +2,32 @@
# KernelSU # KernelSU
A Kernel based root solution for Android GKI. A Kernel based root solution for Android devices.
## Before Reading ## Features
Now KernelSU supports old kernel under 5.10, but **THERE WILL NEVER** be a CI for old kernels, because they are not generic. 1. Kernel-based `su` and root access management.
ANY ISSUES ABOUT HOW TO COMPILE A OLD KERNEL WILL NOT BE ANSWERED AND WILL BE CLOSED. 2. Module system based on overlayfs.
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 ## Compatibility State
Now KernelSU will work on these version of kernels without any modification KernelSU officially supports Android GKI 2.0 devices(with kernel 5.10+), old kernels(4.14+) is also compatiable, but you need to build kernel yourself.
- `5.15` WSA and containter-based Android should also work with KernelSU integrated.
- `5.10`
- `5.4`
- `4.19`
- `4.14`
And the current supported ABIs are : `arm64-v8a` & `x86_64` And the current supported ABIs are : `arm64-v8a` and `x86_64`
If you confirm KernelSU works on other version, open a [issue](https://github.com/tiann/KernelSU/issues) tell us about it!
## Usage ## Usage
1. Flash a custom kernel with KernelSU, you can build it yourself or [download it from CI](https://github.com/tiann/KernelSU/actions). [Installation](https://kernelsu.org/guide/installation.html)
2. Install Manager App and enjoy :)
For old kernels under 5.10, you must build custom kernels by yourself.
## Build ## Build
### Build GKI Kernel [How to build?](https://kernelsu.org/guide/how-to-build.html)
1. Download the GKI source first, you can refer the [GKI build instruction](https://source.android.com/docs/setup/build/building-kernels)
2. cd `<GKI kernel source dir>`
3. `curl -LSs "https://raw.githubusercontent.com/tiann/KernelSU/main/kernel/setup.sh" | bash -`
4. Build the kernel.
### Build the Manager App
Android Studio / Gradle
### Discussion ### Discussion
[@KernelSU](https://t.me/KernelSU) - Telegram: [@KernelSU](https://t.me/KernelSU)
## License ## License

View File

@@ -2,54 +2,32 @@
# KernelSU # KernelSU
一个基于内核,为安卓 GKI 准备的 root 方案。 一个 Android 上基于内核的 root 方案。
## 阅读之前 ## 特性
现在 KernelSU 已经支持 5.10 以下的旧内核,但**永远不会**有旧内核的 CI因为它们不是通用的 - 基于内核的 su 和权限管理
**任何关于如何编译旧内核的问题都不会得到任何答复并将被关闭。** - 基于 overlayfs 的模块系统。
KernelSU 还处于早期开发阶段你不应该生产环境中使用它。KernelSU 的开发者将不对你的任何损失负责。
如果你遇到任何问题,请打开 [issue](https://github.com/tiann/KernelSU/issues) 告诉我们! (最好使用英语)
## 兼容状态 ## 兼容状态
现在,KernelSU 可以在这些版本的内核上正常工作,不需要任何修改 KernelSU 官方支持 GKI 2.0 的设备内核版本5.10以上旧内核也是兼容的最低4.14+,不需要自己编译内核
- `5.15` WSA 和运行在容器上的 Android 也可以与 KernelSU 一起工作。
- `5.10`
- `5.4`
- `4.19`
- `4.14`
目前支持架构 : `arm64-v8a` & `x86_64` 目前支持架构 : `arm64-v8a` `x86_64`
如果你确认 KernelSU 能在其他版本上工作,请打开一个 [issue](https://github.com/tiann/KernelSU/issues) 告诉我们!
## 使用方法 ## 使用方法
1. 用 KernelSU 刷入一个自定义的内核,你可以自己构建它或者[从 CI 下载](https://github.com/tiann/KernelSU/actions) [安装教程](https://kernelsu.org/zh_CN/guide/installation.html)
2. 安装管理器应用, 然后享受吧 :)
对于 5.10 以下的旧内核, 你必须自己构建。
## 构建 ## 构建
### 构建GKI内核 [如何构建?](https://kernelsu.org/zh_CN/guide/how-to-build.html)
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) - Telegram: [@KernelSU](https://t.me/KernelSU)
## 许可证 ## 许可证