diff --git a/docs/0_prerequisites.md b/docs/0_prerequisites.md index 9d86cd543..e58fd4163 100644 --- a/docs/0_prerequisites.md +++ b/docs/0_prerequisites.md @@ -4,10 +4,10 @@ In order to use ReVanced Manager, certain requirements must be met. ## 🤝 Requirements -- An Android device running Android 8 or higher +- An Android device running Android Oreo (8.0) or higher ## ⏭️ What's next -The next page will guide you through patching an app. +The next page will guide you through the installation of ReVanced Manager. Continue: [⬇️ Installation](1_installation.md) diff --git a/docs/2_4_managing_downloaders.md b/docs/2_4_managing_downloaders.md index 0123f40a1..334fdf866 100644 --- a/docs/2_4_managing_downloaders.md +++ b/docs/2_4_managing_downloaders.md @@ -1,10 +1,11 @@ # 🧩 Managing downloaders Learn how to manage downloaders. -Refer to the [template](https://github.com/ReVanced/revanced-manager-downloader-template) if you are developer who wants to create a plugin. +Refer to the [template](https://github.com/ReVanced/revanced-manager-downloader-template) if you are a developer who wants to create a plugin. -Downloaders are APK files and are installed, updated and uninstalled just like regular Android apps. -Downloaders can execute arbitrary code inside ReVanced Manager and must be marked as trusted before use. Manager will show a notification in the dashboard when a new downloader is discovered. +Downloaders are APK files and installed, updated and uninstalled just like regular Android apps. +Downloaders can execute arbitrary code inside ReVanced Manager and must be marked as trusted before use. +Manager will show a notification in the dashboard when a new downloader is discovered. Trust can also be granted and revoked under `Settings` > `Downloads`. ## ⏭️ What's next diff --git a/docs/2_5_updating.md b/docs/2_5_updating.md index 62a211331..275e1ab92 100644 --- a/docs/2_5_updating.md +++ b/docs/2_5_updating.md @@ -9,7 +9,7 @@ Learn how to update ReVanced Manager. 3. Configure the update settings accordingly[^1] [^1]: By default, ReVanced Manager will check for updates automatically on launch -and let you know when an update is available. +and let you know when an update is available by showing a badge above the icon. ## ⏭️ What's next diff --git a/docs/2_6_settings.md b/docs/2_6_settings.md index fa37c2775..40b6c6084 100644 --- a/docs/2_6_settings.md +++ b/docs/2_6_settings.md @@ -3,11 +3,11 @@ Learn how to configure ReVanced Manager. ## 🔧 Settings - -- **Downloads**: Enable or disable ReVanced Manager downloader and manage past downloaded apps here -- **Import & export**: Import or export patch selections, patch options and the signing keystore +- **General**: Change app language, adjust the appearances of ReVanced Manager app, or enable or disable metered networks check. +- **Updates**: Check for ReVanced Manager app update, or use a pre-release version. +- **Downloads**: Enable or disable ReVanced Manager downloader and manage past downloaded apps here. +- **Import & export**: Import or export patch selections, patch options and the signing keystore. - **Advanced**: - - **API URL**: Set the URL of the ReVanced API, ReVanced Manager will use - **Disable version compatibility check**: Patching versions of apps the patches are explicitly compatible with is enforced. Disabling this will allow patching versions of apps the patches are not explicitly compatible with > ⚠️ Warning @@ -28,6 +28,8 @@ Learn how to configure ReVanced Manager. > ⚠️ Warning > Universal patches do not specify compatibility with an app and may not work on all apps regardless. > Unless you know what you are doing, it is recommended to keep this disabled. + - **(Experimental) Run patcher in another process**: Allow patcher to run faster and use more memory than limit. + - **Export debug logs**: Export debug logs of _ReVanced Manager_ app. - **About**: View more information and links about ReVanced and ReVanced Manager. ## ⏭️ What's next diff --git a/docs/2_usage.md b/docs/2_usage.md index c26172f4c..ec42e0e20 100644 --- a/docs/2_usage.md +++ b/docs/2_usage.md @@ -8,8 +8,9 @@ manage patches, and update or configure ReVanced Manager. 1. [💉 Patching apps](2_1_patching.md) 2. [🧰 Managing apps](2_2_managing_apps.md) 3. [🧩 Managing patches](2_3_managing_patches.md) -4. [🔄 Updating ReVanced Manager](2_4_updating.md) -5. [⚙️ Configuring ReVanced Manager](2_5_settings.md) +4. [🧩 Managing downloaders](2_4_managing_downloaders.md) +4. [🔄 Updating ReVanced Manager](2_5_updating.md) +5. [⚙️ Configuring ReVanced Manager](2_6_settings.md) ## ⏭️ What's next diff --git a/docs/3_troubleshooting.md b/docs/3_troubleshooting.md index da3687169..97d95cf31 100644 --- a/docs/3_troubleshooting.md +++ b/docs/3_troubleshooting.md @@ -12,6 +12,7 @@ Find common issues and their solutions below. - **Patches fail to load**: The selected file is not using the ReVanced API format or the remote URL is not reachable. - **Patching takes too long**: Make sure you are using a device with enough storage space and free memory. Be patient during the patching process. +- **Patching fail because of Out Of Memory error**: Try enabling [_**(Experimental) Run patcher in another process**_](/docs/2_6_settings.md#-settings). ## ⏭️ What's next diff --git a/docs/4_building.md b/docs/4_building.md index 9e52014dc..46d60e8a5 100644 --- a/docs/4_building.md +++ b/docs/4_building.md @@ -11,7 +11,7 @@ This page will guide you through building ReVanced Manager from source. Using [SDKMAN!](https://sdkman.io/): ```sh - sdk install java 17.0.15-tem + sdk install java 17.0.18-tem ``` 2. Clone the repository @@ -33,6 +33,6 @@ This page will guide you through building ReVanced Manager from source. > Example `gradle.properties` file: > > ```properties -> gpr.user = -> gpr.key = +> githubPackagesUsername = +> githubPackagesPassword = > ``` diff --git a/docs/README.md b/docs/README.md index af2926b6c..ccab7c03a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,10 +7,12 @@ 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 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) + 1. [💉 Patching apps](2_1_patching.md) + 2. [🧰 Managing apps](2_2_managing_apps.md) + 3. [🧩 Managing patches](2_3_managing_patches.md) + 4. [🧩 Managing downloaders](2_4_managing_downloaders.md) + 4. [🔄 Updating ReVanced Manager](2_5_updating.md) + 5. [⚙️ Configuring ReVanced Manager](2_6_settings.md) 3. [❔ Troubleshooting](3_troubleshooting.md) 4. [🔨 Building from source](4_building.md)