From 88bce45633214c373f6a61d1ba6ece91a0b3ecc9 Mon Sep 17 00:00:00 2001 From: AkinaAcct <108107785+AkinaAcct@users.noreply.github.com> Date: Thu, 7 Nov 2024 23:40:50 +0800 Subject: [PATCH] update readme --- README.md | 37 ++++++++++++++++++++++++++++++------- 1 file changed, 30 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index bf925ce..bf666a1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# APatch Auto Patch Tool +# APatchTool + +Aka. APatch Auto Patch Tool A script that provides custom patching options. > [!WARNING] @@ -10,20 +12,18 @@ This script has the following functions: - User-specified image path or get from current Android device. - User-specified KernelPatch version. Or default, latest release. -- User-specified SuperKey. [What is SuperKey?](https://apatch.top/faq.html#what-is-superkey) +- User-specified SuperKey. [What is SuperKey?](https://apatch.top/faq.html#what-is-superkey) - Supports directly install. - Supports OTA updates. - Supports embedding KPMs. -> [!NOTE] -> Because of some problems that may occur, support for all terminal software other than [Termux](https://github.com/Termux/termux-app) has been dropped. -> With other terminal softwares, you will get a warning and we are not responsible for problems that arise. - --- ## Usage -- Open Termux(**Other terminal app in Android is not support!**) +### Android + +- Open Termux - Prepare @@ -41,6 +41,29 @@ Usage: ./AAP.sh -h ``` +### Linux + +> [!NOTE] +> This should work. If you encounter any problems, please submit an issue with logs provided by debug mode. + +- Just like in Termux: + +```sh +cd ${HOME} +curl -LO https://raw.githubusercontent.com/AkinaAcct/APatchAutoPatchTool/main/AAP.sh +chmod +x AAP.sh +``` + +- Run + +Usage: + +```sh +./AAP.sh -h +``` + +--- + If you have issues or need feedback, please run `AAP.sh` in debug mode. To enable debug mode, run: ```sh