docs: Update README

PATCHES_GUIDE.md

@@ -1,47 +0,0 @@
-# Customizing ReVanced Builds
-
-**Please read the following information before beginning.**
-
-By default the script will build ReVanced with ALL default* patches. Copy `chosen_patches.txt` inside your provided working directory and edit it to customize your build of ReVanced.
-
-*Default: All patches except those which have to be ***included*** explicitly, i.e, using the `-i` flag while manually using the ReVanced CLI
-
-## !IMPORTANT!
-1. Each patch name MUST start from a NEWLINE AND there should be only ONE patch PER LINE
-2. DO NOT add any other type of symbol or character, it will break the script! You have been warned!
-3. Anything starting with a hash (`#`) will be ignored. Also, do not add hash or any other character after a patch's name
-4. Both YT Music ReVanced & YT ReVanced are supported
-5. DO NOT add `microg-patch` to the list of excluding patches.
-6. `patches.txt` contains some predefined lines starting with `#`. DO NOT remove them.
-
-## Example
-Example content of `patches.txt`:
-
-- Exclude pure black theme and keep `create` button:
-```
-amoled
-disable-create-button
-```
-
-- Exclude patches for both Music & YouTube (order doesn't matter)
-```
-amoled
-exclusive-background-playback
-disable-create-button
-premium-heading
-tasteBuilder-remover
-```
-
-- Include patches for both Music & YouTube (order doesn't matter)
-```
-compact-header
-hdr-auto-brightness
-autorepeat-by-default
-enable-debugging
-force-vp9-codec
-enable-wide-searchbar
-```
-
-## List of Available Patches
-
-Refer to Official ReVanced [list of available patches](https://github.com/revanced/revanced-patches#list-of-available-patches).

README.md

@@ -1,12 +1,19 @@
 # Revanced Builder
-This repo will allow one to build [ReVanced](https://github.com/revanced/) apps automatically and post it to a telegram channel to access and possibly share the builds with friends. It uses [Gotify](https://gotify.net), [ntfy.sh](https://ntfy.sh) or [telegram.sh](https://github.com/fabianonline/telegram.sh) to send messages and [telegram-upload](https://github.com/Nekmo/telegram-upload) to upload files (optionally, disabled out by default). Make sure that `Java >=17` is installed and selected as default.
+This repo will allow one to build [ReVanced](https://github.com/revanced/) apps automatically and send notifications and possibly share the builds with friends. It uses [Gotify](https://gotify.net), [ntfy.sh](https://ntfy.sh) or [telegram.sh](https://github.com/fabianonline/telegram.sh) to send messages. Make sure that `Java >=17` is installed and selected as default.
 
+## Installation
+Recommended way is to use [`pipx`](https://github.com/pypa/pipx) to install the program.
+```
+pipx install git+https://github.com/SinTan1729/ReVancedBuilder
+```
 ## How to use
-Just run `./build_revanced <working-directory> (force/clean/experimental/checkonly/buildonly)`. Might be a good idea to set it up to run periodically. There are a few ways of doing it.
+Just run `ReVancedBuilder <working-directory> (force/experimental/checkonly/buildonly)`.
+
+It might be a good idea to set it up to run periodically. There are a few ways of doing it.
 1. Just drop it inside `/etc/cron.daily/`.
 1. To make it run at a specific time (6AM in the example) using `cron`, put this in your `crontab`:
     ```
-    0 6 * * * <full-script-location> <full-working-directory-location>
+    0 6 * * * <program-full-location> <full-working-directory-location>
     ```
 1. The exact same thing as in 2 can be achieved using `systemd` timers instead. Create the following files.
     ```
@@ -22,7 +29,7 @@ Just run `./build_revanced <working-directory> (force/clean/experimental/checkon
     User=<user>
     Group=<group>
     Environment="_JAVA_OPTIONS=-Xmx512m"
-    ExecStart=<full-script-location> <full-working-directory-location>
+    ExecStart=<program-full-location> <full-working-directory-location>
     ```
     ```
     /etc/systemd/system/revanced-builder.timer
@@ -42,19 +49,12 @@ 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`.
+- If you installed it using `pipx`, you can figure out the full location of the program by running `which ReVancedBuilder`.
-    ```
+- This app needs some config files to run. Download all the config files inside `exampl_configs` directory, namely `build_config`, `chosen_patches` (optional), and `notification_config` (optional, needed only if you want to send notifications) and move them to your working directory. Then, you should modify these files to your liking.
-    htmlq jq wget java curl
+- The script will download the **automatically selected compatible version** (unless version is specified in `build_config`) (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.
-    ```
-- 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 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.
+- If you enable telegram notifications, make sure to fill up the config options inside the `build_config` 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`.
+- It can also run a post script (if exists), specified in the `build_config` file. 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.
+- 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 using the `build_config` file. The config files are self-explanatory.
 - 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.
-
-By default this will build ReVanced with ALL available patches. Follow [this guide](PATCHES_GUIDE.md) to exclude/customizing patches for your build.

example_configs/build_config

@@ -34,7 +34,7 @@ root = false
 # Timestamp and extension will be added automatically
 output_name = YouTube_Music_ReVanced_nonroot
 keystore = revanced-ytm-nonroot.keystore
-version = 6.10.52
+# version = version
 
 [youtube_music_root]
 build = false
@@ -45,7 +45,7 @@ root = true
 # Timestamp and extension will be added automatically
 output_name = YouTube_Music_ReVanced_root
 keystore = revanced-ytm-root.keystore
-version = 6.10.52
+# version = version
 
 [post_script]
 # file = post_script.sh