docs: init

docs/revanced-development/0_prerequisites.md

@@ -0,0 +1,20 @@
+# Requirements
+
+- ADB
+- x86/x86_64 host architecture
+- Zulu JDK 17
+- Latest Android SDK if you plan to build the integrations from the source
+- The APK file you want to patch (e.g. YouTube v17.41.37 or YouTube Music v5.23.50). If you want to mount patched applications as root, make sure the same version is installed on your device.
+
+You can continue by either [building everything from source](2_building_from_source.md) or [downloading the prebuilt packages](1_downloading.md).
+
+## Overview
+
+- [Prerequisites](0_prerequisites.md)
+  - [Downloading prebuilt Packages](1_downloading.md)
+  - [Building from source](2_building_from_source.md)
+  - [1. Building the ReVanced Patcher](3_building_revanced_patcher.md)
+    - [2. Building the ReVanced Patches](4_building_revanced_patches.md)
+    - [3. Building the ReVanced Integrations](5_building_revanced_integrations.md)
+    - [4. Building the ReVanced CLI](6_building_revanced_cli.md)
+- [Using the ReVanced CLI](7_usage.md)

docs/revanced-development/1_downloading.md

@@ -0,0 +1,9 @@
+# Downloading the packages
+
+- [ReVanced CLI](https://github.com/revanced/revanced-cli/releases/latest)
+- [ReVanced Patches](https://github.com/revanced/revanced-patches/releases/latest)
+- [ReVanced Integrations](https://github.com/revanced/revanced-integrations/releases/latest)
+
+## Next step
+
+[Using the ReVanced CLI](7_usage.md)

docs/revanced-development/2_building_from_source.md

@@ -0,0 +1,21 @@
+# Building from source
+
+If you have already downloaded the prebuilt packages you can skip to [Using the ReVanced CLI](7_usage.md).
+
+Before continuing you need to be authenticated to GitHub Packages.
+\
+This will assume you have a GitHub account. Create a PAT with the scope `read:packages` [here](https://github.com/settings/tokens/new?scopes=read:packages&description=Revanced) and add your token to ~/.gradle/gradle.properties.
+\
+Example `gradle.properties` file:
+
+```properties
+gpr.user = YourUsername
+gpr.key = ghp_longrandomkey
+```
+
+## Overview
+
+1. [Building the ReVanced Patcher](3_building_revanced_patcher.md)
+2. [Building the ReVanced Patches](4_building_revanced_patches.md)
+3. [Building the ReVanced Integrations](5_building_revanced_integrations.md)
+4. [Building the ReVanced CLI](6_building_revanced_cli.md)

docs/revanced-development/3_building_revanced_patcher.md

@@ -0,0 +1,17 @@
+# Building the ReVanced Patcher
+
+1. Clone the repository
+
+   ```bash
+   git clone https://github.com/revanced/revanced-patcher && cd revanced-patcher
+   ```
+
+2. Publish the patcher to your local maven repository
+
+   ```bash
+   ./gradlew publish
+   ```
+
+## Next step
+
+[Building the ReVanced Patches](4_building_revanced_patches.md)

docs/revanced-development/4_building_revanced_patches.md

@@ -0,0 +1,19 @@
+# Building the ReVanced Patches
+
+1. Clone the repository
+
+   ```bash
+   git clone https://github.com/revanced/revanced-patches && cd revanced-patches
+   ```
+
+2. Build the patches
+
+   ```bash
+   ./gradlew build
+   ```
+
+The file will be located in `build/libs/revanced-patches-VERSION.jar`
+
+## Next step
+
+[Building the ReVanced integrations](5_building_revanced_integrations.md)

docs/revanced-development/5_building_revanced_integrations.md

@@ -0,0 +1,21 @@
+# Building the ReVanced Integrations
+
+1. Make sure `$ANDROID_SDK_ROOT` or `$ANDROID_HOME` is set correctly
+
+2. Clone the repository
+
+   ```bash
+   git clone https://github.com/revanced/revanced-integrations && cd revanced-integrations
+   ```
+
+3. Build the integrations
+
+   ```bash
+   ./gradlew build
+   ```
+
+The file will be located in `app/build/outputs/apk/release/app-release-unsigned.apk`
+
+## Next step
+
+[Building the ReVanced CLI](6_building_revanced_cli.md)

docs/revanced-development/6_building_revanced_cli.md

@@ -0,0 +1,19 @@
+# Building the ReVanced CLI
+
+1. Clone the repository
+
+```bash
+git clone https://github.com/revanced/revanced-cli && cd revanced-cli
+```
+
+Build the CLI
+
+```bash
+./gradlew build
+```
+
+The file will be located in `build/libs/revanced-cli-VERSION-all.jar`
+
+## Next step
+
+[Using the ReVanced CLI](7_usage.md)

docs/revanced-development/7_usage.md

@@ -0,0 +1,47 @@
+# Using the ReVanced CLI
+
+1. Make sure your device is connected
+
+   ```bash
+   adb shell exit
+   ```
+
+2. If you plan to use the root variant, check if you have root access
+
+   ```bash
+   adb shell su -c exit
+   ```
+
+3. Copy the ADB device name
+
+   ```bash
+   adb devices
+   ```
+
+4. Run the CLI
+
+   ```bash
+   # Non-Root
+   java -jar revanced-cli-all.jar \
+   -a input.apk \
+   -c \
+   -d device-name \
+   -o output.apk \
+   -b revanced-patches.jar
+
+   # Root
+   # In the case of YouTube you want to exlude the patch 'microg-support' with the option '-e'. The option '-e' allows you to exclude patches (e.g. -e microg-support -e amoled ...)
+   java -jar revanced-cli-all.jar \
+   -a input.apk \
+   -c \
+   -d device-name \
+   -o output.apk \
+   -b revanced-patches.jar \
+   -e microg-support \
+   --mount
+   ```
+
+> :warning: A lot of patches require the integrations which you can merge by adding the `-m` flag and passing the `integrations` file as the argument.
+> If you need the list of patches available, pass in `-l`.
+
+If you specified an ADB device the application should now open on your device and the CLI will show logs until the app is closed.

docs/revanced-development/README.md

@@ -0,0 +1,14 @@
+# 💻 ReVanced Development
+
+Instructions to build and install ReVanced.
+
+## 📖 Table of contents
+
+- [Prerequisites](0_prerequisites.md)
+  - [Downloading prebuilt Packages](1_downloading.md)
+  - [Building from source](2_building_from_source.md)
+  - [1. Building the ReVanced Patcher](3_building_revanced_patcher.md)
+    - [2. Building the ReVanced Patches](4_building_revanced_patches.md)
+    - [3. Building the ReVanced Integrations](5_building_revanced_integrations.md)
+    - [4. Building the ReVanced CLI](6_building_revanced_cli.md)
+- [Using the ReVanced CLI](7_usage.md)