ReVanced-Mirror/revanced-manager
1
0
Fork 0
mirror of https://github.com/revanced/revanced-manager synced 2024-05-14 13:56:57 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: simplify steps

Browse Source
This commit is contained in:
oSumAtrIX 2023-06-16 05:09:52 +02:00
parent e2d7ab8f8f
commit cebfa7c8ae
No known key found for this signature in database
GPG Key ID: A9B3094ACDB604B4
8 changed files with 50 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/0_prerequisites.md
View File

@ -11,6 +11,6 @@ In order to use ReVanced Manager, certain requirements must be met.
## ⏭️ What's next
The next page will guide you through patching an application.
The next page will guide you through patching an app.
Continue: [⬇️ Installation](1_installation.md)

6
docs/1_installation.md
View File

@ -4,11 +4,11 @@ In order to use ReVanced on your Android device, ReVanced Manager must be instal
## 🪜 Installation steps
- Download the latest version of ReVanced Manager from [here](https://github.com/revanced/revanced-manager/releases/latest)
- Install ReVanced Manager
1. Download the latest version of ReVanced Manager from [here](https://github.com/revanced/revanced-manager/releases/latest)
2. Install ReVanced Manager
## ⏭️ What's next
The next page will guide you through patching an application.
The next page will guide you through patching an app.
Continue: [🪛 Usage](2_usage.md)

33
docs/2_1_patching.md
View File

@ -1,26 +1,25 @@
# 🧩 Patching applications
# 🧩 Patching apps
The following pages will guide you through using ReVanced Manager to patch applications.
The following pages will guide you through using ReVanced Manager to patch apps.
## 🪜 Steps to patch applications
## 🪜 Steps to patch apps
1. Navigate to the **Patcher** tab from the bottom navigation bar
2. Tap on the **Select an application** card
3. Choose an application to patch[^1]
> **Note**: The application version suggested by ReVanced Manager is visible in each application's card. This is important in step 5. below, as most patches are compatible with this version.
2. Tap on the **Select an app** card
3. Choose an app to patch[^1]
> **Note**: The suggested version is visible in each app's card.
4. Tap on the **Select patches** card and select the patches you want to apply[^2]
> **Warning**: If you see a warning icon next to a patch, it means that the patch is not compatible with the application version you selected in step 3. above. In this case, you should either go back and select a different application version or deselect the patch.
5. Tap on the **Done** button to confirm your selection
6. Tap on the **Patch** button to start patching
> **Warning**: The patching process can take anywhere from 2 to 5 minutes depending on your device. Refrain from exiting ReVanced Manager while the process is still running, otherwise the patching time will increase significantly.
7. After patching is complete, tap on the **Install** button to install the patched application
> **Note**: If you have root access on your device, you may have the option to mount the patched application on top of the original application.[^4]
> Optionally, you may tap on the three vertical dots in the top right to export the patched application to storage.
> **Warning**: If you see a warning you can click on it for more information.
5. Tap on the **Done** then **Patch** button
> **Warning**: The patching process may take ~5 minutes. Exiting the app may increase the time it takes to patch.
6. Tap on the **Install** button
> **Note**: If you are rooted, you can mount the patched app on top of the original app.[^4]
> Optionally, you may export the patched app to storage in the top right corner.
[^1]: You may be prompted to select an application from storage in case you have no root access on your device. In this case, select the APK file from your device storage.[^3]
[^2]: It is suggested to use the default set of patches by tapping on the **Default** chip above the list of patches.
[^3]: You can obtain `.apk` files from sites such as [APKMirror](https://www.apkmirror.com/).
[^4]: Mounting the patched application on top of the original application will only work if the installed application version matches the version of the application selected in step 3. above.
[^1]: You may be prompted to select an app from storage in case you have no root access on your device. In this case, select the APK file from your device storage.[^3]
[^2]: It is suggested to use the default set of patches by tapping on the **Default** button above the list of patches.
[^3]: You have to source APK files yourself. ReVanced does not provide any APK files.
[^4]: Mounting the patched app on top of the original app will only work if the installed app version matches the version of the app selected in step 3. above.
## ⏭️ What's next

8
docs/2_2_managing.md
View File

@ -1,12 +1,12 @@
# 🧰 Managing patched applications
# 🧰 Managing patched apps
After patching an application, you may want to manage it. This page will guide you through managing patched applications.
After patching an app, you may want to manage it. This page will guide you through managing patched apps.
## 🪜 Steps to manage patched applications
## 🪜 Steps to manage patched apps
1. Tap on the **Dashboard** tab in the bottom navigation bar
2. Select the **Installed** chip
3. Tap on the **Info** button for the application you want to manage
3. Tap on the **Info** button for the app you want to manage
4. Choose one of the options from the menu
## ⏭️ What's next

6
docs/2_4_settings.md
View File

@ -14,15 +14,15 @@ ReVanced Manager has settings that can be configured to your liking.
- ### 🧪 Experimental ReVanced Patches support
Lift application version constraints from ReVanced Patches. This allows you to patch any version of an application, even if the patch is not explicitly compatible with it.
Lift app version constraints from ReVanced Patches. This allows you to patch any version of an app, even if the patch is not explicitly compatible with it.
- ### 🧑‍🔬 Experimental universal support
This will show or hide ReVanced Patches, which are not meant for any application in particular but rather for all applications but may not work on all applications.
This will show or hide ReVanced Patches, which are not meant for any app in particular but rather for all apps but may not work on all apps.
- ### 🔑 Export, import or delete keystore
Manage the keystore used to sign patched applications.
Manage the keystore used to sign patched apps.
- ### 📄 Export, import or reset ReVanced Patches selection

6
docs/2_usage.md
View File

@ -1,11 +1,11 @@
# 🛠️ Usage
The following pages will guide you through using ReVanced Manager to patch applications, manage patched applications, and update ReVanced Manager.
The following pages will guide you through using ReVanced Manager to patch apps, manage patched apps, and update ReVanced Manager.
## 📖 Table of contents
1. [🧩 Patching applications](2_1_patching.md)
2. [🧰 Managing patched applications](2_2_managing.md)
1. [🧩 Patching apps](2_1_patching.md)
2. [🧰 Managing patched apps](2_2_managing.md)
3. [🔄 Updating ReVanced Manager](2_3_updating.md)
4. [⚙️ Configuring ReVanced Manager](2_4_settings.md)

20
docs/3_troubleshooting.md
View File

@ -2,23 +2,27 @@
In case you encounter any issues while using ReVanced Manager, please refer to this page for possible solutions.
- ### 💥 App not installed as package conflicts with an existing package
- 💉 Patching fails with an error
An existing installation of the application you're trying to patch is conflicting with the patched application. Uninstall the existing application before installing the patched application.
Make sure ReVanced Manager is up to date by following [🔄 Updating ReVanced Manager](2_3_updating.md) and select the **Default** button when choosing patches.
- ### ❗️Error code `135`, `139` or `1` when patching the application
- 💥 App not installed as package conflicts with an existing package
An existing installation of the app you're trying to patch is conflicting with the patched app. Uninstall the existing app before installing the patched app.
- ❗️ Error code `135`, `139` or `1` when patching the app
Your device is not supported. Refer to the [Prerequisites](0_prerequisites.md) page for supported devices.
Alternatively, you can use [ReVanced CLI](https://github.com/revanced/revanced-cli) to patch the application.
Alternatively, you can use [ReVanced CLI](https://github.com/revanced/revanced-cli) to patch the app.
- ### 🚫 Non-root install is not possible with the current patches selection
- 🚫 Non-root install is not possible with the current patches selection
Select the **Default** chip when choosing patches.
Select the **Default** button when choosing patches.
- ### 🚨 Patched application crashes on launch
- 🚨 Patched app crashes on launch
Select the **Default** chip when choosing patches.
Select the **Default** button when choosing patches.
## ⏭️ What's next

10
docs/README.md
View File

@ -7,9 +7,15 @@ This documentation explains how to use [ReVanced Manager](https://github.com/rev
0. [💼 Prerequisites](0_prerequisites.md)
1. [⬇️ Installation](1_installation.md)
2. [🛠️ Usage](2_usage.md)
1. [🧩 Patching applications](2_1_patching.md)
2. [🧰 Managing patched applications](2_2_managing.md)
1. [🧩 Patching apps](2_1_patching.md)
2. [🧰 Managing patched apps](2_2_managing.md)
3. [🔄 Updating ReVanced Manager](2_3_updating.md)
4. [⚙️ Configuring ReVanced Manager](2_4_settings.md)
3. [🛟 Troubleshooting](3_troubleshooting.md)
4. [🛠 Building from source](4_building.md)
## ⏭️ Start here
The next page will tell you about the prerequisites for using ReVanced Manager.
Continue: [💼 Prerequisites](0_prerequisites.md)