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
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.
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!
1. Kernel-based `su` and root access management.
2. Module system based on overlayfs.
## 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`
- `5.10`
- `5.4`
- `4.19`
- `4.14`
WSA and containter-based Android should also work with KernelSU integrated.
And the current supported ABIs are : `arm64-v8a` & `x86_64`
If you confirm KernelSU works on other version, open a [issue](https://github.com/tiann/KernelSU/issues) tell us about it!
And the current supported ABIs are : `arm64-v8a` and `x86_64`
## Usage
1. Flash a custom kernel with KernelSU, you can build it yourself or [download it from CI](https://github.com/tiann/KernelSU/actions).
2. Install Manager App and enjoy :)
For old kernels under 5.10, you must build custom kernels by yourself.
[Installation](https://kernelsu.org/guide/installation.html)
## Build
### Build GKI Kernel
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
[How to build?](https://kernelsu.org/guide/how-to-build.html)
### Discussion
[@KernelSU](https://t.me/KernelSU)
- Telegram: [@KernelSU](https://t.me/KernelSU)
## License