From 39d6962320abdf56b84f26d19121a22ea6533978 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=B1=B3=E5=87=9BMiRin?= <148533509+MiRinChan@users.noreply.github.com> Date: Sun, 15 Jun 2025 01:35:25 +0800 Subject: [PATCH] modified: docs/README-en.md (#170) modified: docs/README.md --- docs/README-en.md | 37 +++++++++++++++++++++++-------------- docs/README.md | 10 ++++++---- 2 files changed, 29 insertions(+), 18 deletions(-) diff --git a/docs/README-en.md b/docs/README-en.md index 46e1e373..ce619b35 100644 --- a/docs/README-en.md +++ b/docs/README-en.md @@ -13,18 +13,20 @@ Android device root solution based on [KernelSU](https://github.com/tiann/Kernel ## How to add Using main branching (non-GKI device builds are not supported) (requires manual integration of susfs) + ``` curl -LSs "https://raw.githubusercontent.com/SukiSU-Ultra/SukiSU-Ultra/main/kernel/setup.sh" | bash -s main ``` Using branches that support non-GKI devices (requires manual integration of susfs) + ``` curl -LSs "https://raw.githubusercontent.com/SukiSU-Ultra/SukiSU-Ultra/main/kernel/setup.sh" | bash -s nongki ``` ## How to use integrated susfs -1. Use susfs-main or other susfs-* branches directly, no need to integrate susfs again (supports non-GKI device builds) +1. Use susfs-main or other susfs-\* branches directly, no need to integrate susfs again (supports non-GKI device builds) ``` curl -LSs "https://raw.githubusercontent.com/SukiSU-Ultra/SukiSU-Ultra/main/kernel/setup.sh" | bash -s susfs-main @@ -40,15 +42,18 @@ We will introduce more APatch-compatible functions to ensure the completeness of KPM templates: https://github.com/udochina/KPM-Build-Anywhere > [!Note] +> > 1. `CONFIG_KPM=y` needs to be added. > 2. Non-GKI devices need to add `CONFIG_KALLSYMS=y` and `CONFIG_KALLSYMS_ALL=y` as well. > 3. Some kernel source code below `4.19` also needs to be backport from `4.19` to the header file `set_memory.h`. ## How to do a system update to retain ROOT + - After OTA, don't reboot first, go to the manager flashing/patching kernel interface, find `GKI/non_GKI install` and select the Anykernel3 kernel zip file that needs to be flashed, select the slot that is opposite to the current running slot of the system for flashing, and then reboot to retain the GKI mode update （This method is not supported for all non-GKI devices, so please try it yourself. It is the safest way to use TWRP for non-GKI devices.） - Or use LKM mode to install to the unused slot (after OTA). ## Compatibility Status + - KernelSU (versions prior to v1.0.0) officially supports Android GKI 2.0 devices (kernel 5.10+) - Older kernels (4.4+) are also compatible, but the kernel must be built manually @@ -57,28 +62,31 @@ KPM templates: https://github.com/udochina/KPM-Build-Anywhere - Currently supports `arm64-v8a`, `armeabi-v7a (bare)` and some `X86_64` - ## More links **If you need to submit a translation for the manager go to** https://crowdin.com/project/SukiSU-Ultra Projects compiled based on Sukisu and susfs -- [GKI](https://github.com/ShirkNeko/GKI_KernelSU_SUSFS) + +- [More patched GKI](https://github.com/ShirkNeko/GKI_KernelSU_SUSFS) including ZRAM patches, KPM, susfs... +- [Less patched GKI](https://github.com/MiRinFork/GKI_SukiSU_SUSFS/releases) only susfs - [OnePlus](https://github.com/ShirkNeko/Action_OnePlus_MKSU_SUSFS) ## Hook method + - This method references the hook method from (https://github.com/rsuntk/KernelSU) 1. **KPROBES hook:** - - Also used for Loadable Kernel Module (LKM) - - Default hook method on GKI kernels. - - Need `CONFIG_KPROBES=y` + + - Also used for Loadable Kernel Module (LKM) + - Default hook method on GKI kernels. + - Need `CONFIG_KPROBES=y` 2. **Manual hook:** - - Standard KernelSU hook: https://kernelsu.org/guide/how-to-integrate-for-non-gki.html#manually-modify-the-kernel-source - - backslashxx's syscall manual hook: https://github.com/backslashxx/KernelSU/issues/5 - - Default hook method on Non-GKI kernels. - - Need `CONFIG_KSU_MANUAL_HOOK=y` + - Standard KernelSU hook: https://kernelsu.org/guide/how-to-integrate-for-non-gki.html#manually-modify-the-kernel-source + - backslashxx's syscall manual hook: https://github.com/backslashxx/KernelSU/issues/5 + - Default hook method on Non-GKI kernels. + - Need `CONFIG_KSU_MANUAL_HOOK=y` ## Usage @@ -87,16 +95,17 @@ Projects compiled based on Sukisu and susfs Please **all** refer to https://kernelsu.org/zh_CN/guide/installation.html > [!Note] +> > 1. for devices with GKI 2.0 such as Xiaomi, Redmi, Samsung, etc. (excludes kernel-modified manufacturers such as Meizu, OnePlus, Zenith, and oppo) -> 2. Find the GKI build in [more links](#%E6%9B%B4%E5%A4%9A%E9%93%BE%E6%8E%A5). Find the device kernel version. Then download it and use TWRP or kernel flashing tool to flash the zip file with AnyKernel3 suffix. +> 2. Find the GKI build in [more links](#%E6%9B%B4%E5%A4%9A%E9%93%BE%E6%8E%A5). Find the device kernel version. Then download it and use TWRP or kernel flashing tool to flash the zip file with AnyKernel3 suffix. Pixel user need use _Less patched GKI_. > 3. The .zip archive without suffix is uncompressed, the gz suffix is the compression used by Tenguet models. - ### OnePlus 1. Use the link mentioned in the 'More Links' section to create a customized build with your device information, and then flash the zip file with the AnyKernel3 suffix. > [!Note] +> > - You only need to fill in the first two parts of kernel versions, such as 5.10, 5.15, 6.1, or 6.6. > - Please search for the processor codename by yourself, usually it is all English without numbers. > - You can find the branch and configuration files from the OnePlus open-source kernel repository. @@ -105,7 +114,7 @@ Please **all** refer to https://kernelsu.org/zh_CN/guide/installation.html 1. Kernel-based `su` and root access management. 2. Not based on [OverlayFS](https://en.wikipedia.org/wiki/OverlayFS) module system, but based on [Magic Mount](https://github.com/5ec1cff/KernelSU) from 5ec1cff -3. [App Profile](https://kernelsu.org/guide/app-profile.html): Lock root privileges in a cage. +3. [App Profile](https://kernelsu.org/guide/app-profile.html): Lock root privileges in a cage. 4. Bringing back non-GKI/GKI 1.0 support 5. More customization 6. Support for KPM kernel modules @@ -118,7 +127,7 @@ Please **all** refer to https://kernelsu.org/zh_CN/guide/installation.html - The file in the “kernel” directory is under [GPL-2.0-only](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) license. -- The images of the files `ic_launcher(?!.*alt.*).*` with anime character emoticons are copyrighted by [五十根大虾仁](https://space.bilibili.com/370927), the Brand Intellectual Property in the images is owned by [明风OuO](https://space.bilibili.com/274939213), and the vectorization is done by @MiRinChan. Before using these files, in addition to complying with [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.txt), you also need to comply with the authorization of the two authors to use these artistic contents. +- The images of the files `ic_launcher(?!.*alt.*).*` with anime character emoticons are copyrighted by [五十根大虾仁](https://space.bilibili.com/370927), the Brand Intellectual Property in the images is owned by [明风 OuO](https://space.bilibili.com/274939213), and the vectorization is done by @MiRinChan. Before using these files, in addition to complying with [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.txt), you also need to comply with the authorization of the two authors to use these artistic contents. - Except for the files or directories mentioned above, all other parts are under [GPL-3.0 or later](https://www.gnu.org/licenses/gpl-3.0.html) license. diff --git a/docs/README.md b/docs/README.md index 5f5be73b..e4cd78f1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -28,7 +28,7 @@ curl -LSs "https://raw.githubusercontent.com/SukiSU-Ultra/SukiSU-Ultra/main/kern ## 如何集成 susfs -1. 直接使用 susfs-main 或者其他susfs-* 分支，不需要再集成 susfs (支持非 GKI 设备构建) +1. 直接使用 susfs-main 或者其他 susfs-\* 分支，不需要再集成 susfs (支持非 GKI 设备构建) ``` curl -LSs "https://raw.githubusercontent.com/SukiSU-Ultra/SukiSU-Ultra/main/kernel/setup.sh" | bash -s susfs-main @@ -86,7 +86,8 @@ KPM 模板地址: https://github.com/udochina/KPM-Build-Anywhere 基于 SukiSU 和 susfs 编译的项目 -- [GKI](https://github.com/ShirkNeko/GKI_KernelSU_SUSFS) +- [增强 GKI](https://github.com/ShirkNeko/GKI_KernelSU_SUSFS)（包括 ZRAM 算法等补丁、KPM、susfs 等） +- [GKI](https://github.com/MiRinFork/GKI_SukiSU_SUSFS/releases)（若增强 GKI boot 失败再尝试这份，这份没有 KPM 等修改，只有 susfs） - [一加](https://github.com/ShirkNeko/Action_OnePlus_MKSU_SUSFS) ## 使用方法 @@ -98,7 +99,7 @@ KPM 模板地址: https://github.com/udochina/KPM-Build-Anywhere > [!Note] > > 1. 适用于如小米、红米、三星等的 GKI 2.0 的设备 (不包含魔改内核的厂商如魅族、一加、真我和 oppo) -> 2. 找到[更多链接](#%E6%9B%B4%E5%A4%9A%E9%93%BE%E6%8E%A5)里的 GKI 构建的项目。找到设备内核版本。然后下载下来，用 TWRP 或者内核刷写工具刷入带 AnyKernel3 后缀的压缩包即可 +> 2. 找到[更多链接](#%E6%9B%B4%E5%A4%9A%E9%93%BE%E6%8E%A5)里的 GKI 构建的项目。找到设备内核版本。然后下载下来，用 TWRP 或者内核刷写工具刷入带 AnyKernel3 后缀的压缩包即可。Pixel 请使用不是增强的 GKI。 > 3. 一般不带后缀的 .zip 压缩包是未压缩的，gz 后缀的为天玑机型所使用的压缩方式 ### 一加 @@ -121,12 +122,13 @@ KPM 模板地址: https://github.com/udochina/KPM-Build-Anywhere 6. 对 KPM 内核模块的支持 ## 疑难解答 + 1. 卸载 KernelSU 管理器设备卡死。→ 卸载包名为 com.sony.playmemories.mobile 的应用。 ## 许可证 - `kernel` 目录下的文件是 [GPL-2.0-only](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)。 -- 有动漫人物图片表情包的这些文件 `ic_launcher(?!.*alt.*).*` 的图像版权为[五十根大虾仁](https://space.bilibili.com/370927)所有，图像中的 Brand Intellectual Property 由[明风OuO](https://space.bilibili.com/274939213)所有，矢量化由 @MiRinChan 完成，在使用这些文件之前，除了必须遵守 [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.txt) 以外，还需要遵守向前两者索要使用这些艺术内容的授权。 +- 有动漫人物图片表情包的这些文件 `ic_launcher(?!.*alt.*).*` 的图像版权为[五十根大虾仁](https://space.bilibili.com/370927)所有，图像中的 Brand Intellectual Property 由[明风 OuO](https://space.bilibili.com/274939213)所有，矢量化由 @MiRinChan 完成，在使用这些文件之前，除了必须遵守 [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.txt) 以外，还需要遵守向前两者索要使用这些艺术内容的授权。 - 除了以上所述的文件或目录外，所有其他部分均为 [GPL-3.0 或更高版本](https://www.gnu.org/licenses/gpl-3.0.html)。 ## 爱发电链接