ReVanced-Mirror/revanced-cli
1
0
Fork 0
mirror of https://github.com/revanced/revanced-cli.git synced 2025-01-07 09:45:50 +01:00
Code Issues Projects Releases Wiki Activity

docs: Format markdown code

Browse Source
This commit is contained in:
oSumAtrIX 2024-02-23 03:03:51 +01:00
parent a4e8d2df0d
commit f2368ccf27
No known key found for this signature in database
GPG Key ID: A9B3094ACDB604B4
2 changed files with 16 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -64,9 +64,9 @@ This document describes how to contribute to ReVanced CLI.
## 📖 Resources to help you get started ## 📖 Resources to help you get started
* The [documentation](/docs) explains how to use ReVanced CLI - The [documentation](/docs) explains how to use ReVanced CLI
* [Our backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on - [Our backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on
* [Issues](https://github.com/ReVanced/revanced-cli/issues) are where we keep track of bugs and feature requests - [Issues](https://github.com/ReVanced/revanced-cli/issues) are where we keep track of bugs and feature requests
## 🙏 Submitting a feature request ## 🙏 Submitting a feature request
@ -94,5 +94,5 @@ If you encounter a bug while using ReVanced CLI, open an issue using the
5. Our team will review your pull request and provide feedback. Once your pull request is approved, 5. Our team will review your pull request and provide feedback. Once your pull request is approved,
it will be merged into the `dev` branch and will be included in the next release of ReVanced CLI it will be merged into the `dev` branch and will be included in the next release of ReVanced CLI
❤️ Thank you for considering contributing to ReVanced CLI, ❤️ Thank you for considering contributing to ReVanced CLI,
ReVanced ReVanced

25
docs/1_usage.md
View File

@ -26,7 +26,7 @@ ReVanced CLI is divided into the following fundamental commands:
This will generate an `options.json` file for the patches from a list of supplied patch bundles. This will generate an `options.json` file for the patches from a list of supplied patch bundles.
The file can be supplied to ReVanced CLI later on. The file can be supplied to ReVanced CLI later on.
```bash ```bash
java -jar revanced-cli.jar options \ java -jar revanced-cli.jar options \
--path options.json \ --path options.json \
@ -35,14 +35,14 @@ ReVanced CLI is divided into the following fundamental commands:
``` ```
> **ℹ️ Note** > **ℹ️ Note**
> A default `options.json` file will be automatically created if it does not exist > A default `options.json` file will be automatically created if it does not exist
without any need for intervention when using the `patch` command. > without any need for intervention when using the `patch` command.
- ### 💉 Patch an app - ### 💉 Patch an app
You can patch apps by supplying patch bundles and the app to patch. You can patch apps by supplying patch bundles and the app to patch.
After patching, ReVanced CLI can install the patched app on your device using two methods: After patching, ReVanced CLI can install the patched app on your device using two methods:
> **💡 Tip** > **💡 Tip**
> For ReVanced CLI to be able to install the patched app on your device, make sure ADB is working: > For ReVanced CLI to be able to install the patched app on your device, make sure ADB is working:
> >
@ -55,7 +55,6 @@ ReVanced CLI is divided into the following fundamental commands:
> ```bash > ```bash
> adb shell su -c exit > adb shell su -c exit
> ``` > ```
>
> **⚠️ Warning** > **⚠️ Warning**
> Some patches may require integrations > Some patches may require integrations
@ -72,10 +71,10 @@ ReVanced CLI is divided into the following fundamental commands:
``` ```
- #### 👾 Patch an app and mount it on top of the un-patched app with root permissions - #### 👾 Patch an app and mount it on top of the un-patched app with root permissions
> **❗ Caution** > **❗ Caution**
> Ensure that the same app you are patching and mounting over is installed on your device: > Ensure that the same app you are patching and mounting over is installed on your device:
> >
> ```bash > ```bash
> adb install app.apk > adb install app.apk
> ``` > ```
@ -90,18 +89,18 @@ ReVanced CLI is divided into the following fundamental commands:
--mount \ --mount \
app.apk app.apk
``` ```
> **💡 Tip** > **💡 Tip**
> You can use the option `--ii` to include or `--ie` to exclude > You can use the option `--ii` to include or `--ie` to exclude
> patches by their index in relation to supplied patch bundles, > patches by their index in relation to supplied patch bundles,
> similarly to the option `--include` and `--exclude`. > similarly to the option `--include` and `--exclude`.
> >
> This is useful in case two patches have the same name, and you must include or exclude one. > This is useful in case two patches have the same name, and you must include or exclude one.
> The patch index is calculated by the position of the patch in the list of patches > The patch index is calculated by the position of the patch in the list of patches
> from patch bundles supplied using the option `--patch-bundle`. > from patch bundles supplied using the option `--patch-bundle`.
> >
> You can list all patches with their indices using the command `list-patches`. > You can list all patches with their indices using the command `list-patches`.
> >
> Keep in mind that the indices can change based on the order of the patch bundles supplied, > Keep in mind that the indices can change based on the order of the patch bundles supplied,
> as well if the patch bundles are updated because patches can be added or removed. > as well if the patch bundles are updated because patches can be added or removed.
@ -115,7 +114,7 @@ ReVanced CLI is divided into the following fundamental commands:
> **💡 Tip** > **💡 Tip**
> You can unmount an APK file > You can unmount an APK file
by adding the option `--unmount`. > by adding the option `--unmount`.
- ### ️ 📦 Install an app - ### ️ 📦 Install an app
@ -126,5 +125,5 @@ ReVanced CLI is divided into the following fundamental commands:
``` ```
> **💡 Tip** > **💡 Tip**
> You can mount an APK file > You can mount an APK file
> by supplying the app's package name to mount the supplied APK file over the option `-mount`. > by supplying the app's package name to mount the supplied APK file over the option `-mount`.