Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AkinaAcct committed Nov 7, 2024
1 parent 5215efa commit 88bce45
Showing 1 changed file with 30 additions and 7 deletions.
37 changes: 30 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# APatch Auto Patch Tool
# APatchTool

Aka. APatch Auto Patch Tool

A script that provides custom patching options.
> [!WARNING]
Expand All @@ -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

Expand All @@ -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
Expand Down

0 comments on commit 88bce45

Please sign in to comment.