diff --git a/docs/README.md b/docs/README.md index 3e99c1e8..63ff5f94 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,30 +1,27 @@ -**English** | [Español](README_ES.md) | [简体中文](README_CN.md) | [繁體中文](README_TW.md) | [日本語](README_JP.md) | [한국어](README_KR.md) | [Polski](README_PL.md) | [Português (Brasil)](README_PT-BR.md) | [Türkçe](README_TR.md) | [Русский](README_RU.md) | [Tiếng Việt](README_VI.md) | [Indonesia](README_ID.md) | [עברית](README_IW.md) | [हिंदी](README_IN.md) | [Italiano](README_IT.md) - -# KernelSU +# KernelSU Next logo A Kernel-based root solution for Android devices. -[![Latest release](https://img.shields.io/github/v/release/tiann/KernelSU?label=Release&logo=github)](https://github.com/tiann/KernelSU/releases/latest) -[![Weblate](https://img.shields.io/badge/Localization-Weblate-teal?logo=weblate)](https://hosted.weblate.org/engage/kernelsu) -[![Channel](https://img.shields.io/badge/Follow-Telegram-blue.svg?logo=telegram)](https://t.me/KernelSU) +[![Latest release](https://img.shields.io/github/v/release/rifsxd/KernelSU?label=Release&logo=github)](https://github.com/rifsxd/KernelSU/releases/latest) [![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/tiann/KernelSU?logo=gnu)](/LICENSE) ## Features 1. Kernel-based `su` and root access management. -2. Module system based on [OverlayFS](https://en.wikipedia.org/wiki/OverlayFS). +2. Module system based on [Magic Mount](https://github.com/topjohnwu/Magisk/blob/c512496847d182526f2043295ecfd275398eccac/docs/releases/26100.md#new-magic-mount-implementation). 3. [App Profile](https://kernelsu.org/guide/app-profile.html): Lock up the root power in a cage. ## Compatibility State -KernelSU officially supports Android GKI 2.0 devices (kernel 5.10+). Older kernels (4.14+) are also compatible, but the kernel will have to be built manually. +KernelSU Next supports most Android kernels starting from 4.14 upto 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.19) kernels also need to be rebuilt with KernelSU driver. (3.18+ is experimental) -With this, WSA, ChromeOS, and container-based Android are all supported. - -Currently, only `arm64-v8a` and `x86_64` are supported. +Currently, only `arm64-v8a` is supported. ## Usage @@ -32,14 +29,6 @@ Currently, only `arm64-v8a` and `x86_64` are supported. - [How to build?](https://kernelsu.org/guide/how-to-build.html) - [Official Website](https://kernelsu.org/) -## Translation - -To help translate KernelSU or improve existing translations, please use [Weblate](https://hosted.weblate.org/engage/kernelsu/). PR of Manager's translation is no longer accepted, because it will conflict with Weblate. - -## Discussion - -- Telegram: [@KernelSU](https://t.me/KernelSU) - ## Security For information on reporting security vulnerabilities in KernelSU, see [SECURITY.md](/SECURITY.md). @@ -55,3 +44,5 @@ For information on reporting security vulnerabilities in KernelSU, see [SECURITY - [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 him or else KernelSU Next wouldn't even exist. +- [Magic Mount Port](https://github.com/5ec1cff/KernelSU/blob/main/userspace/ksud/src/magic_mount.rs): 💜 for saving KernelSU!