diff --git a/docs/README.md b/docs/README.md index 58925777..d71115b7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,63 +1,91 @@ -**English** | [简体中文](README_CN.md) | [繁體中文](README_TW.md) | [Türkçe](README_TR.md) | [Português (Brasil)](README_PT-BR.md) | [한국어](README_KO.md) | [Français](README_FR.md) | [Bahasa Indonesia](README_ID.md) | [Русский](README_RU.md) | [ภาษาไทย](README_TH.md) | [Tiếng Việt](README_VI.md) | [Italiano](README_IT.md) | [Polski](README_PL.md) | [Български](README_BG.md) | [日本語](README_JA.md) | [Українська](README_UA.md) +**Languages**: +[English](README.md) | [简体中文](README_CN.md) | [繁體中文](README_TW.md) | [Türkçe](README_TR.md) | [Português (Brasil)](README_PT-BR.md) | [한국어](README_KO.md) | [Français](README_FR.md) | [Bahasa Indonesia](README_ID.md) | [Русский](README_RU.md) | [ภาษาไทย](README_TH.md) | [Tiếng Việt](README_VI.md) | [Italiano](README_IT.md) | [Polski](README_PL.md) | [Български](README_BG.md) | [日本語](README_JA.md) | [Українська](README_UA.md) -# KernelSU Next +--- -logo +
+ KernelSU Next Logo + +

KernelSU Next

+

A kernel-based root solution for Android devices.

-A kernel-based root solution for Android devices. +

+ + Latest Release + + + Nightly Build + + + License: GPL v2 + + + GitHub License + +

+
-[![Latest Release](https://img.shields.io/github/v/release/KernelSU-Next/KernelSU-Next?label=Release&logo=github)](https://github.com/KernelSU-Next/KernelSU-Next/releases/latest) -[![Nightly Release](https://img.shields.io/badge/Nightly%20Release-gray?logo=hackthebox&logoColor=fff)](https://nightly.link/KernelSU-Next/KernelSU-Next/workflows/build-manager-ci/next/Manager) -[![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-orange.svg?logo=gnu)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) -[![GitHub License](https://img.shields.io/github/license/KernelSU-Next/KernelSU-Next?logo=gnu)](/LICENSE) +--- -## Features +## 🚀 Features -1. Kernel-based `su` and root access management. -2. Module system based on dynamic mount system [Magic Mount](https://topjohnwu.github.io/Magisk/details.html#magic-mount) / [OverlayFS](https://en.wikipedia.org/wiki/OverlayFS). -3. [App Profile](https://kernelsu.org/guide/app-profile.html): Lock up the root power in a cage. +- Kernel-based `su` and root access management +- Module system based on **[Magic Mount](https://topjohnwu.github.io/Magisk/details.html#magic-mount)** and **[OverlayFS](https://en.wikipedia.org/wiki/OverlayFS)** +- [App Profiles](https://kernelsu.org/guide/app-profile.html): Limit root privileges per app -## Compatibility state +--- -KernelSU Next officially supports most Android kernels starting from 4.4 up to 6.6. - - GKI 2.0 (5.10+) kernels can run pre-built images and LKM/KMI. - - GKI 1.0 (4.19 - 5.4) kernels need to rebuilt with KernelSU driver. - - EOL (<4.14) kernels also need to be rebuilt with KernelSU driver (3.18+ is experimental and may need some function backports). +## ✅ Compatibility -Currently, only the `arm64-v8a`, `armeabi-v7a` & `x86_64` architectures are supported. +KernelSU Next supports Android kernels from **4.4 up to 6.6**: -## Usage +| Kernel Version | Support Notes | +|----------------|---------------| +| 5.10+ (GKI 2.0) | Supports pre-built images and LKM/KMI | +| 4.19 – 5.4 (GKI 1.0) | Requires KernelSU driver built-in | +| <4.14 (EOL) | Requires KernelSU driver (3.18+ is experimental, may need backports) | -- [Installation instruction](https://kernelsu-next.github.io/webpage/pages/installation.html) +**Supported Architectures:** +`arm64-v8a`, `armeabi-v7a`, `x86_64` -## Security +--- -For information on reporting security vulnerabilities in KernelSU, see [SECURITY.md](/SECURITY.md). +## 📦 Installation -## License +Please refer to the [Installation Guide](https://kernelsu-next.github.io/webpage/pages/installation.html) for setup instructions. -- Files under the `kernel` directory are [GPL-2.0-only](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html). -- All other parts except the `kernel` directory are [GPL-3.0-or-later](https://www.gnu.org/licenses/gpl-3.0.html). +--- -## Donations +## 🔐 Security -- 0x12b5224b7aca0121c2f003240a901e1d064371c1 [ USDT BEP20 ] +To report security issues, please see [SECURITY.md](/SECURITY.md). -- TYUVMWGTcnR5svnDoX85DWHyqUAeyQcdjh [ USDT TRC20 ] +--- -- 0x12b5224b7aca0121c2f003240a901e1d064371c1 [ USDT ERC20 ] +## 📜 License -- 0x12b5224b7aca0121c2f003240a901e1d064371c1 [ ETH ERC20 ] +- **`/kernel` directory:** [GPL-2.0-only](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) +- **All other files:** [GPL-3.0-or-later](https://www.gnu.org/licenses/gpl-3.0.html) -- Ld238uYBuRQdZB5YwdbkuU6ektBAAUByoL [ LTC ] +--- -- 19QgifcjMjSr1wB2DJcea5cxitvWVcXMT6 [ BTC ] +## 💸 Donations -## Credits +If you’d like to support the project: -- [Kernel-Assisted Superuser](https://git.zx2c4.com/kernel-assisted-superuser/about/): The KernelSU idea. -- [Magisk](https://github.com/topjohnwu/Magisk): The powerful root tool. -- [genuine](https://github.com/brevent/genuine/): APK v2 signature validation. -- [Diamorphine](https://github.com/m0nad/Diamorphine): Some rootkit skills. -- [KernelSU](https://github.com/tiann/KernelSU): Thanks to tiann, or else KernelSU Next wouldn't even exist. -- [Magic Mount Port](https://github.com/5ec1cff/KernelSU/blob/main/userspace/ksud/src/magic_mount.rs): 💜 5ec1cff for saving KernelSU! +- **USDT (BEP20, ERC20)**: `0x12b5224b7aca0121c2f003240a901e1d064371c1` +- **USDT (TRC20)**: `TYUVMWGTcnR5svnDoX85DWHyqUAeyQcdjh` +- **ETH (ERC20)**: `0x12b5224b7aca0121c2f003240a901e1d064371c1` +- **LTC**: `Ld238uYBuRQdZB5YwdbkuU6ektBAAUByoL` +- **BTC**: `19QgifcjMjSr1wB2DJcea5cxitvWVcXMT6` + +--- + +## 🙏 Credits + +- [Kernel-Assisted Superuser](https://git.zx2c4.com/kernel-assisted-superuser/about/) – Concept inspiration +- [Magisk](https://github.com/topjohnwu/Magisk) – Root foundation +- [Genuine](https://github.com/brevent/genuine/) – APK v2 signature validation +- [Diamorphine](https://github.com/m0nad/Diamorphine) – Rootkit techniques +- [KernelSU](https://github.com/tiann/KernelSU) – The foundation for KernelSU Next +- [Magic Mount Port](https://github.com/5ec1cff/KernelSU/blob/main/userspace/ksud/src/magic_mount.rs) – 💜 to 5ec1cff for keeping KernelSU alive