README & docs: Revise the README and documentation. Thanks to lama's help.

2025-07-16 19:28:16 +08:00
parent 11e9e37f43
commit 86456a4d95
11 changed files with 557 additions and 309 deletions
--- a/docs/zh/README.md
+++ b/docs/zh/README.md
@@ -0,0 +1,101 @@
+<img align='right' src='zakomonochrome-128.svg' width='100px' alt="logo">
+
+# SukiSU Ultra
+
+[English](../README.md) | **简体中文** | [日本語](../ja/README.md) | [Türkçe](../tr/README.md)
+
+一个 Android 上基于内核的 root 方案，由 [`tiann/KernelSU`](https://github.com/tiann/KernelSU) 分叉而来，添加了一些有趣的变更。
+
+[![最新发行](https://img.shields.io/github/v/release/SukiSU-Ultra/SukiSU-Ultra?label=Release&logo=github)](https://github.com/tiann/KernelSU/releases/latest)
+[![频道](https://img.shields.io/badge/Follow-Telegram-blue.svg?logo=telegram)](https://t.me/Sukiksu)
+[![协议: 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 协议](https://img.shields.io/github/license/tiann/KernelSU?logo=gnu)](/LICENSE)
+
+## 特性
+
+1. 基于内核的 `su` 和权限管理。
+2. 基于 [Magic Mount](https://github.com/5ec1cff/KernelSU) 的模块系统。
+3. [App Profile](https://kernelsu.org/zh_CN/guide/app-profile.html): 把 Root 权限关进笼子里。
+4. 支持 non-GKI 与 GKI 1.0。
+5. KPM 支持
+6. 可调整管理器外观，可自定义 susfs 配置。
+
+## 兼容状态
+
+- KernelSU 官方支持 GKI 2.0 的设备（内核版本 5.10 以上）。
+
+- 旧内核也是兼容的（最低 4.14+），不过需要自己编译内核。
+
+- With more backports, KernelSU can supports 3.x kernel (3.4-3.18).
+
+- 目前支持架构 : `arm64-v8a`、`armeabi-v7a (bare)`、`X86_64`。
+
+## 安装指导
+
+查看 [`guide/installation.md`](guide/installation.md)
+
+## 集成指导
+
+查看 [`guide/how-to-integrate.md`](guide/how-to-integrate.md)
+
+## 参与翻译
+
+要将 SukiSU 翻译成您的语言，或完善现有的翻译，请使用 [Crowdin](https://crowdin.com/project/SukiSU-Ultra).
+
+## KPM 支持
+
+- 基于 KernelPatch 开发，移除了与 KernelSU 重复的功能。
+- 正在进行（WIP）：通过集成附加功能来扩展 APatch 兼容性，以确保跨不同实现的兼容性。
+
+**开源仓库**: [https://github.com/ShirkNeko/SukiSU_KernelPatch_patch](https://github.com/ShirkNeko/SukiSU_KernelPatch_patch)
+
+**KPM 模板**: [https://github.com/udochina/KPM-Build-Anywhere](https://github.com/udochina/KPM-Build-Anywhere)
+
+> [!Note]
+>
+> 1. 需要 `CONFIG_KPM=y`
+> 2. Non-GKI 设备需要 `CONFIG_KALLSYMS=y` and `CONFIG_KALLSYMS_ALL=y`
+> 3. 对于低于 `4.19` 的内核，需要从 `4.19` 的 `set_memory.h` 进行反向移植。
+
+## Troubleshooting
+
+1. 卸载管理器后系统卡住？
+   卸载 _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/10545509)所有，图像中的知识产权由[明风 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-or-later](https://www.gnu.org/licenses/gpl-3.0.html)。
+
+## 赞助
+
+- [ShirkNeko](https://afdian.com/a/shirkneko) (SukiSU 主要维护者)
+- [weishu](https://github.com/sponsors/tiann) (KernelSU 作者)
+
+## ShirkNeko 的赞助列表
+
+- [Ktouls](https://github.com/Ktouls) 非常感谢你给我带来的支持
+- [zaoqi123](https://github.com/zaoqi123) 请我喝奶茶也不错
+- [wswzgdg](https://github.com/wswzgdg) 非常感谢对此项目的支持
+- [yspbwx2010](https://github.com/yspbwx2010) 非常感谢
+- [DARKWWEE](https://github.com/DARKWWEE) 感谢老哥的 100 USDT
+- [Saksham Singla](https://github.com/TypeFlu) 网站的提供以及维护
+- [OukaroMF](https://github.com/OukaroMF) 网站域名捐赠
+
+## 鸣谢
+
+- [KernelSU](https://github.com/tiann/KernelSU): 上游
+- [MKSU](https://github.com/5ec1cff/KernelSU): 魔法坐骑支持
+- [RKSU](https://github.com/rsuntk/KernelsU): non-GKI 支持
+- [susfs](https://gitlab.com/simonpunk/susfs4ksu): 隐藏内核补丁以及用户空间模组的 KernelSU 附件
+- [KernelPatch](https://github.com/bmax121/KernelPatch): KernelPatch 是内核模块 APatch 实现的关键部分
+
+<details>
+<summary>KernelSU 的鸣谢</summary>
+
+- [kernel-assisted-superuser](https://git.zx2c4.com/kernel-assisted-superuser/about/)：KernelSU 的灵感。
+- [Magisk](https://github.com/topjohnwu/Magisk)：强大的 root 工具箱。
+- [genuine](https://github.com/brevent/genuine/)：apk v2 签名验证。
+- [Diamorphine](https://github.com/m0nad/Diamorphine)：一些 rootkit 技巧。
+</details>
--- a/docs/zh/guide/how-to-integrate.md
+++ b/docs/zh/guide/how-to-integrate.md
@@ -0,0 +1,91 @@
+# 集成
+
+SukiSU 可以集成到 GKI 和 non-GKI 内核中，并且已反向移植到 4.14 版本。
+
+<!-- 应该是 3.4 版本，但 backslashxx 的 syscall manual hook 无法在 SukiSU 中使用-->
+
+此定制可能导致多达 50% 的内核代码超出内核树代码，而非来自上游 Linux 内核或 ACK。因此，non-GKI 内核的定制特性导致了严重的内核碎片化，而且我们缺乏构建它们的通用方法。因此，我们无法提供 non-GKI 内核的启动映像。
+
+前提条件：开源的、可启动的内核。
+
+## Hook 方法
+
+1. **KPROBES hook:**
+
+   - GKI kernels 的默认 hook 方法。
+   - 需要 `# CONFIG_KSU_MANUAL_HOOK is not set`（未设定） & `CONFIG_KPROBES=y`
+   - 用作可加载的内核模块 (LKM).
+
+2. **Manual hook:**
+
+   <!-- - backslashxx's syscall manual hook: https://github.com/backslashxx/KernelSU/issues/5 (v1.5 version is not available at the moment, if you want to use it, please use v1.4 version, or standard KernelSU hooks)-->
+
+   - 需要 `CONFIG_KSU_MANUAL_HOOK=y`
+   - 需要 [`guide/how-to-integrate.md`](guide/how-to-integrate.md)
+   - 需要 [https://github.com/~](https://github.com/tiann/KernelSU/blob/main/website/docs/guide/how-to-integrate-for-non-gki.md#manually-modify-the-kernel-source)
+
+<!-- This part refer to [rsuntk/KernelSU](https://github.com/rsuntk/KernelSU). -->
+
+如果您能够构建可启动内核，有两种方法可以将 KernelSU 集成到内核源代码中：
+
+1. 使用 `kprobe` 自动集成
+2. 手动集成
+
+## 与 kprobe 集成
+
+适用：
+
+- GKI 内核
+
+不适用：
+
+- non-GKI 内核
+
+KernelSU 使用 kprobe 机制来做内核的相关 hook，如果 _kprobe_ 可以在你编译的内核中正常运行，那么推荐用这个方法来集成。
+
+请参阅此文档 [https://github.com/~](https://github.com/tiann/KernelSU/blob/main/website/docs/guide/how-to-integrate-for-non-gki.md#integrate-with-kprobe)。虽然标题为“适用于 non-GKI”，但仅适用于 GKI。
+
+替换 KernelSU 添加到内核源代码树的步骤的执行命令为：
+
+```sh
+curl -LSs "https://raw.githubusercontent.com/SukiSU-Ultra/SukiSU-Ultra/main/kernel/setup.sh" | bash -s main
+```
+
+## 手动修改内核源代码
+
+适用：
+
+- GKI 内核
+- non-GKI 内核
+
+请参考此文档 [https://github.com/~ (non-GKI 内核集成)](https://github.com/tiann/KernelSU/blob/main/website/docs/guide/how-to-integrate-for-non-gki.md#manually-modify-the-kernel-source) 和 [https://github.com/~ (GKI 内核构建)](https://kernelsu.org/zh_CN/guide/how-to-build.html) 进行手动集成。虽然第一个链接的标题是“适用于 non-GKI”，但它也适用于 GKI。两者都可以正常工作。
+
+还有另一种集成方法，但是仍在开发中。
+
+<!-- 这是 backslashxx 的syscall manual hook，但目前无法使用。 -->
+
+将 KernelSU（SukiSU）添加到内核源代码树的步骤的运行命令将被替换为：
+
+### GKI 内核
+
+```sh
+curl -LSs "https://raw.githubusercontent.com/SukiSU-Ultra/SukiSU-Ultra/main/kernel/setup.sh" | bash -s main
+```
+
+### non-GKI 内核
+
+```sh
+curl -LSs "https://raw.githubusercontent.com/SukiSU-Ultra/SukiSU-Ultra/main/kernel/setup.sh" | bash -s nongki
+```
+
+### 带有 susfs 的 GKI / non-GKI 内核（实验）
+
+```sh
+curl -LSs "https://raw.githubusercontent.com/SukiSU-Ultra/SukiSU-Ultra/main/kernel/setup.sh" | bash -s susfs-{{branch}}
+```
+
+分支:
+
+- `main` (susfs-main)
+- `test` (susfs-test)
+- 版本号 (例如： susfs-1.5.7, 你需要在 [分支](https://github.com/SukiSU-Ultra/SukiSU-Ultra/branches) 里找到它)
--- a/docs/zh/guide/installation.md
+++ b/docs/zh/guide/installation.md
@@ -0,0 +1,34 @@
+# Installation
+
+您可以前往 [KernelSU 文档 - 安装](https://kernelsu.org/guide/installation.html) 获取有关如何安装的参考，这里只是额外的说明。
+
+## 通过加载可加载内核模块 (LKM) 进行安装
+
+请参阅 [KernelSU 文档 - LKM 安装](https://kernelsu.org/guide/installation.html#lkm-installation)
+
+从 **Android™**（商标，意为获得 Google 移动服务的许可）12 开始，搭载内核版本 5.10 或更高版本的设备必须搭载 GKI 内核。因此你或许可以使用 LKM 模式。
+
+## 通过安装内核进行安装
+
+请参阅 [KernelSU 文档 - GKI 模式安装](https://kernelsu.org/guide/installation.html#gki-mode-installation)
+
+我们提供预编译的内核供您使用：
+
+- [ShirkNeko 内核](https://github.com/ShirkNeko/GKI_KernelSU_SUSFS)（添加了 ZRAM 压缩算法补丁、susfs 文件和 KPM 文件。适用于很多设备。）
+- [MiRinFork 内核](https://github.com/MiRinFork/GKI_SukiSU_SUSFS)（添加了 susfs 文件和 KPM 文件。最接近 GKI 的内核，适用于大多数设备。）
+
+虽然某些设备可以使用 LKM 模式安装，但无法使用 GKI 内核将其安装到设备上；因此，需要手动修改内核进行编译。例如：
+
+- 欧珀（一加、真我）
+- 魅族
+
+此外，我们还为您的 OnePlus 设备提供预编译的内核：
+
+- [ShirkNeko/Action_OnePlus_MKSU_SUSFS](https://github.com/ShirkNeko/Action_OnePlus_MKSU_SUSFS)（添加 ZRAM 压缩算法补丁、susfs 和 KPM。）
+
+使用上面的链接，Fork 到 GitHub Action，填写构建参数，进行编译，最后将 zip 文件以 AnyKernel3 后缀上传到 GitHub Action。
+
+> [!Note]
+>
+> - 使用时，您只需填写版本号的前两部分，例如 `5.10`、`6.1`...
+> - 使用前请确保您了解处理器名称、内核版本等信息。
--- a/docs/zh/zakomonochrome-128.svg
+++ b/docs/zh/zakomonochrome-128.svg
@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   width="128"
+   height="128"
+   viewBox="0 0 128 128"
+   version="1.1"
+   id="svg1"
+   inkscape:version="1.4.2 (ebf0e940d0, 2025-05-08)"
+   sodipodi:docname="zakomonochrome-128.svg"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg">
+  <sodipodi:namedview
+     id="namedview1"
+     pagecolor="#ffffff"
+     bordercolor="#999999"
+     borderopacity="1"
+     inkscape:showpageshadow="2"
+     inkscape:pageopacity="0"
+     inkscape:pagecheckerboard="0"
+     inkscape:deskcolor="#d1d1d1"
+     inkscape:document-units="px"
+     inkscape:zoom="2.6185048"
+     inkscape:cx="59.957881"
+     inkscape:cy="71.032903"
+     inkscape:window-width="1280"
+     inkscape:window-height="696"
+     inkscape:window-x="0"
+     inkscape:window-y="0"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="layer1" />
+  <defs
+     id="defs1" />
+  <g
+     inkscape:label="图层 1"
+     inkscape:groupmode="layer"
+     id="layer1">
+    <rect
+       style="fill:#ffffff;stroke:#000000;stroke-width:0;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:1.3;stroke-dasharray:none;paint-order:fill markers stroke;fill-opacity:1"
+       id="rect1"
+       width="128"
+       height="128"
+       x="0"
+       y="0"
+       rx="7.772471"
+       ry="7.772471" />
+    <path
+       id="path101"
+       style="fill:#ffffff;fill-opacity:0.734285;stroke:#000000;stroke-width:4.27504;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:1.3;stroke-dasharray:none;stroke-opacity:1;paint-order:fill markers stroke"
+       d="m 42.510282,81.796052 c 0,0 -7.224141,-5.638356 -10.043315,-9.338525 M 14.847106,81.97224 25.41902,71.576535 m 0.17619,-6.695549 2.819179,19.910444 M 11.675534,73.338532 38.281518,71.047931 M 43.567475,62.7666 34.40515,62.942814 M 34.22896,62.590425 33.524162,48.494537 m -18.500855,1.58577 17.972249,-1.409582 m -11.8053,-5.462154 0.352397,18.853251"
+       inkscape:label="杂" />
+    <path
+       id="path111"
+       style="fill:#ffffff;fill-opacity:0.734285;stroke:#000000;stroke-width:3.94824;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:1.3;stroke-dasharray:none;stroke-opacity:1;paint-order:fill markers stroke"
+       d="M 55.912937,82.876745 79.671596,81.412163 M 59.330273,75.391135 74.952411,74.089291 m -9.43837,-14.157553 1.139102,14.645756 m -8.299247,-7.160159 16.273048,-1.464569 m 0.650926,8.136525 0.325472,-14.808482 m -0.162747,0.162739 -17.900363,0.976379 m 0,-0.162738 1.952774,14.645756 m 12.042061,-21.154974 1.464576,-6.346492 m 0,-0.650928 -12.042063,0.650928 m -0.650918,6.509218 0.325459,-8.787441"
+       inkscape:label="鱼" />
+    <path
+       d="m 95.08569,51.121163 c -1.90515,0.116064 -3.64694,0.97349 -4.86738,2.391307 -1.34538,1.56738 -1.91476,3.733159 -1.59523,6.070852 0.40842,2.982962 2.1502,6.17135 5.13887,9.411078 0.63424,0.68546 1.08109,1.129773 1.98202,1.967071 1.58321,1.469144 3.01507,2.634638 4.9875,4.052454 0.70392,0.50905 2.09253,1.453525 2.61627,1.781734 l 0.15133,0.09594 0.22103,-0.140663 c 0.80481,-0.515755 2.23909,-1.504852 3.08956,-2.130057 3.21689,-2.364488 5.79232,-4.737902 7.70228,-7.100167 3.09676,-3.831409 4.4133,-7.562359 3.80549,-10.773058 -0.42043,-2.210414 -1.82588,-4.039057 -3.81992,-4.967887 -0.85767,-0.399664 -1.69132,-0.607312 -2.6355,-0.656431 -1.22285,-0.0647 -2.42648,0.178619 -3.57485,0.721182 -1.95561,0.922124 -3.58927,2.719503 -4.61752,5.081755 -0.072,0.165235 -0.1394,0.310355 -0.14895,0.319295 -0.0312,0.02902 -0.0648,-0.02679 -0.19458,-0.330457 -0.30752,-0.714476 -0.91055,-1.752718 -1.38382,-2.377871 -0.4853,-0.645282 -1.2661,-1.431214 -1.84749,-1.862143 -1.50155,-1.114153 -3.26013,-1.658924 -5.00914,-1.553996 z"
+       id="path1-4"
+       style="fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.00231605" />
+  </g>
+</svg>