SinTan1729/ReVancedBuilder
1
0
Fork 0
mirror of https://github.com/SinTan1729/ReVancedBuilder.git synced 2024-12-26 12:48:36 -06:00
Code Issues Projects Releases Packages Wiki Activity

doc: Updated README

Browse source
This commit is contained in:
Sayantan Santra 2023-07-28 15:01:31 -05:00
parent 5574f573fb
commit cbafa597fc
Signed by: SinTan1729
GPG key ID: EB3E68BFBA25C85F
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -10,15 +10,15 @@ Just run `./build_revanced <working-directory> (force/clean/experimental/checkon
## Notes
- The following programs are needed to run this script. Make sure that you have them in your `$PATH`.
```
htmlq jq wget java
htmlq jq wget java curl
```
- To enable build for a particular apk, copy the `build_settings` file to your working directory and modify it to suit your needs.
- The script will download the **automatically selected compatible version** (using compatibility of patches as listed [here](https://github.com/revanced/revanced-patches#list-of-available-patches)) of Youtube on APKMirror, **NOT** latest official version on Google Play.
- The script will download the **automatically selected compatible version** (using compatibility of patches as listed [here](https://github.com/revanced/revanced-patches#list-of-available-patches)) of Youtube on APKPure, **NOT** latest official version on Google Play.
- Under **NO CIRCUMSTANCES** any APKs will be uploaded to this repository to avoid DMCA.
- If you enable the Gotify, ntfy or telegram notifications or uploads, make sure to fill up the config options inside the `build_settings` file. For more information about the config, take at look at the repos of `telegram.sh` and `telegram-upload` provided above.
- It can also run a post script (if exists) called `post_script.sh`. The `timestamp` is passed as `$1`.
- In the current configuration, the script only builds YouTube ReVanced and YouTube Music ReVanced (both nonroot), but it's easy to add support for any other ReVanced app. The code for root builds is included but disabled by default.
- All the packages are pulled from [APKMirror](https://apkmirror.com) and GitHub (the `revanced/*` repos).
- All the packages are pulled from [APKPure](https://apkpure.com) and GitHub (the `revanced/*` repos).
## Customize your build
If you wish to continue with the default settings, you may skip this step.