From fe7ec9dcf5b1f73f2ee3bee263d1f1169d8e5d55 Mon Sep 17 00:00:00 2001 From: ShirkNeko <109797057+ShirkNeko@users.noreply.github.com> Date: Mon, 31 Mar 2025 00:15:31 +0800 Subject: [PATCH] docs: update README to clarify branch usage and support for non-GKI devices --- docs/README-en.md | 17 ++++++++++++++--- docs/README.md | 20 +++++++++++++++----- 2 files changed, 29 insertions(+), 8 deletions(-) diff --git a/docs/README-en.md b/docs/README-en.md index 2a4312b2..1a860092 100644 --- a/docs/README-en.md +++ b/docs/README-en.md @@ -15,19 +15,30 @@ Android device root solution based on [KernelSU](https://github.com/KernelSU/Ker ## How to add -Using the susfs-dev branch (integrated susfs with support for non-GKI devices) +Using the susfs-stable or susfs-dev branch (integrated susfs with support for non-GKI devices) + +``` +curl -LSs "https://raw.githubusercontent.com/ShirkNeko/KernelSU/main/kernel/setup.sh" | bash -s susfs-stable +``` + ``` curl -LSs "https://raw.githubusercontent.com/ShirkNeko/KernelSU/main/kernel/setup.sh" | bash -s susfs-dev ``` -Use main branching (no longer with support for non-GKI devices) +Use main branching +``` +curl -LSs "https://raw.githubusercontent.com/ShirkNeko/KernelSU/main/kernel/setup.sh" | bash -s main +``` + +Use dev branching(With support for non-GKI devices) ``` curl -LSs "https://raw.githubusercontent.com/ShirkNeko/KernelSU/main/kernel/setup.sh" | bash -s main ``` ## How to use integrated susfs -Use the susfs-dev branch directly without any patching +1. Use the susfs-dev branch directly without any patching +2. Manually patch susfs using a dev branch that supports non-GKI devices. ## More links diff --git a/docs/README.md b/docs/README.md index 87841e74..9e081c66 100644 --- a/docs/README.md +++ b/docs/README.md @@ -15,20 +15,30 @@ ## 如何添加 在内核源码的根目录下执行以下命令: -使用 susfs-dev 分支(已集成susfs,带非GKI设备的支持) +使用 susfs-stable 或者 susfs-dev 分支(已集成susfs,带非GKI设备的支持) +``` +curl -LSs "https://raw.githubusercontent.com/ShirkNeko/KernelSU/main/kernel/setup.sh" | bash -s susfs-stable +``` + ``` curl -LSs "https://raw.githubusercontent.com/ShirkNeko/KernelSU/main/kernel/setup.sh" | bash -s susfs-dev ``` -使用 main 分支(不再带非GKI设备的支持) + +使用 main 分支 ``` curl -LSs "https://raw.githubusercontent.com/ShirkNeko/KernelSU/main/kernel/setup.sh" | bash -s main ``` + +使用 dev 分支(带非GKI设备的支持) +``` +curl -LSs "https://raw.githubusercontent.com/ShirkNeko/KernelSU/main/kernel/setup.sh" | bash -s main +``` ## 如何集成 susfs -1. 直接使用 susfs-dev 分支,不需要再集成 susfs - +1. 直接使用 susfs-stable 或者 susfs-dev 分支,不需要再集成 susfs +2. 使用支持非GKI设备的 dev 分支,手动补丁 susfs ## 钩子方法 - 此部分引用自 [rsuntk 的钩子方法](https://github.com/rsuntk/KernelSU) @@ -72,7 +82,7 @@ curl -LSs "https://raw.githubusercontent.com/ShirkNeko/KernelSU/main/kernel/setu 1. 基于内核的 `su` 和 root 访问管理 2. 基于 5ec1cff 的 [Magic Mount](https://github.com/5ec1cff/KernelSU) 的模块系统 3. [App Profile](https://kernelsu.org/guide/app-profile.html):将 root 权限锁在笼子里 -4. 恢复对非 GKI 2.0 内核的支持(仅限susfs-dev和未进行susfs补丁的dev分支) +4. 恢复对非 GKI 2.0 内核的支持 5. 更多自定义功能