Ver código fonte

docs: link release to features page, update install instructions

- Release notes now link to docs/index.md features page and use
  absolute GitHub URLs for each feature doc.
- Add Install with Kernel Flasher section to release body (two heredoc
  blocks patched).
- README: remove 📜 Old Build Scripts and kernelsu.org install guide,
  replace with Install with Kernel Flasher steps (AnyKernel3 ZIP +
  Kernel Flasher / PixelFlasher).
TheWildJames 2 semanas atrás
pai
commit
cbc3ab3851
2 arquivos alterados com 39 adições e 8 exclusões
  1. 30 4
      .github/workflows/main.yml
  2. 9 4
      README.md

+ 30 - 4
.github/workflows/main.yml

@@ -1274,7 +1274,7 @@ jobs:
                 enabled.append("Performance Tuning")
             if not enabled:
                 return ""
-            parts = ["## Features Included", "", "Each feature is documented separately in `docs/`:", ""]
+            parts = ["## Features Included", "", "See [Kernel Features Documentation](https://github.com/WildKernels/GKI_KernelSU_SUSFS/blob/dev/docs/index.md) for full details.", ""]
             feature_doc_map = [
                 ("SUSFS", "susfs.md"),
                 ("Baseband Guard", "bbg.md"),
@@ -1288,10 +1288,22 @@ jobs:
             ]
             for feature, doc in feature_doc_map:
                 if feature in enabled:
-                    parts.append(f"- [{feature}](docs/{doc})")
+                    parts.append(f"- [{feature}](https://github.com/WildKernels/GKI_KernelSU_SUSFS/blob/dev/docs/{doc})")
             parts.append("")
             return "\n".join(parts)
 
+        def build_install_section():
+            return (
+                "## Install with Kernel Flasher\n\n"
+                "> [!NOTE]\n"
+                "> This method is more convenient when upgrading KernelSU and can be done without a computer. Make a backup first.\n\n"
+                "**Steps:**\n\n"
+                "1. **Download the AnyKernel3 ZIP.** If you don\'t know which file to download, carefully read the description of KMI and Security patch level in this document.\n"
+                "2. **Open the Kernel Flasher app**, grant necessary root permissions, and use the provided AnyKernel3 ZIP to flash.\n\n"
+                "This requires the [Kernel Flasher](https://github.com/fatalcoder524/KernelFlasher) app to have root permissions. "
+                "Other apps that can be used include [Kernel Flasher](https://github.com/fatalcoder524/KernelFlasher) and [PixelFlasher](https://github.com/badabing2005/PixelFlasher).\n"
+            )
+
         def render():
             parts = []
             parts.append(build_preamble())
@@ -1300,6 +1312,7 @@ jobs:
             parts.append(build_susfs_section())
             parts.append(build_managers_section(parse_managers(env("MANAGER_LIST", ""))))
             parts.append(build_features_section())
+            parts.append(build_install_section())
             return "\n".join(parts)
 
         output = render()
@@ -1534,7 +1547,7 @@ jobs:
                   enabled.append("Performance Tuning")
               if not enabled:
                   return ""
-              parts = ["## Features Included", "", "Each feature is documented separately in `docs/`:", ""]
+              parts = ["## Features Included", "", "See [Kernel Features Documentation](https://github.com/WildKernels/GKI_KernelSU_SUSFS/blob/dev/docs/index.md) for full details.", ""]
               feature_doc_map = [
                   ("SUSFS", "susfs.md"),
                   ("Baseband Guard", "bbg.md"),
@@ -1548,10 +1561,22 @@ jobs:
               ]
               for feature, doc in feature_doc_map:
                   if feature in enabled:
-                      parts.append(f"- [{feature}](docs/{doc})")
+                      parts.append(f"- [{feature}](https://github.com/WildKernels/GKI_KernelSU_SUSFS/blob/dev/docs/{doc})")
               parts.append("")
               return "\n".join(parts)
 
+          def build_install_section():
+              return (
+                  "## Install with Kernel Flasher\n\n"
+                  "> [!NOTE]\n"
+                  "> This method is more convenient when upgrading KernelSU and can be done without a computer. Make a backup first.\n\n"
+                  "**Steps:**\n\n"
+                  "1. **Download the AnyKernel3 ZIP.** If you don\'t know which file to download, carefully read the description of KMI and Security patch level in this document.\n"
+                  "2. **Open the Kernel Flasher app**, grant necessary root permissions, and use the provided AnyKernel3 ZIP to flash.\n\n"
+                  "This requires the [Kernel Flasher](https://github.com/fatalcoder524/KernelFlasher) app to have root permissions. "
+                  "Other apps that can be used include [Kernel Flasher](https://github.com/fatalcoder524/KernelFlasher) and [PixelFlasher](https://github.com/badabing2005/PixelFlasher).\n"
+              )
+
           def render():
               parts = []
               parts.append(build_preamble())
@@ -1560,6 +1585,7 @@ jobs:
               parts.append(build_susfs_section())
               parts.append(build_managers_section(parse_managers(env("MANAGER_LIST", ""))))
               parts.append(build_features_section())
+              parts.append(build_install_section())
               return "\n".join(parts)
 
           output = render()

+ 9 - 4
README.md

@@ -35,16 +35,21 @@ By flashing this kernel, **YOU** are choosing to make these modifications. If so
 
 - 📖 **[Kernel Features Documentation](docs/index.md)** — per-feature documentation
 - 🩹 [Kernel Patches](https://github.com/WildKernels/kernel_patches)
-- 📜 [Old Build Scripts](https://github.com/TheWildJames/kernel_build_scripts)
 - ⚡ [Kernel Flasher](https://github.com/fatalcoder524/KernelFlasher)
 
 ---
 
-## 📋 Installation Instructions
+## 📲 Install with Kernel Flasher
 
-For GKI installation, please follow the official guide:
+> [!NOTE]
+> This method is more convenient when upgrading KernelSU and can be done without a computer. Make a backup first.
 
-📖 **[KernelSU Installation Guide](https://kernelsu.org/guide/installation.html)**
+**Steps:**
+
+1. **Download the AnyKernel3 ZIP.** If you don't know which file to download, carefully read the description of KMI and Security patch level in this document.
+2. **Open the Kernel Flasher app**, grant necessary root permissions, and use the provided AnyKernel3 ZIP to flash.
+
+This requires the [Kernel Flasher](https://github.com/fatalcoder524/KernelFlasher) app to have root permissions. Other kernel flashing apps that can be used include [Kernel Flasher](https://github.com/fatalcoder524/KernelFlasher) and [PixelFlasher](https://github.com/badabing2005/PixelFlasher).
 
 ---