diff --git a/docs/0_prerequisites.md b/docs/0_prerequisites.md index 9e3b481..517ae0e 100644 --- a/docs/0_prerequisites.md +++ b/docs/0_prerequisites.md @@ -4,8 +4,8 @@ To use ReVanced CLI, you will need to fulfill specific requirements. ## 🤝 Requirements -- Java SDK 11 (Azul Zulu JDK or OpenJDK) -- [Android Debug Bridge (adb)](https://developer.android.com/studio/command-line/adb) if you want to install the patched APK file on your device +- Java Runtime Environment 11 (Azul Zulu JRE or OpenJDK) +- [Android Debug Bridge (ADB)](https://developer.android.com/studio/command-line/adb) if you want to install the patched APK file on your device - An ABI other than ARMv7 such as x86 or x86-64 (or a custom AAPT binary that supports ARMv7) ## ⏭️ Whats next diff --git a/docs/2_building.md b/docs/2_building.md new file mode 100644 index 0000000..7055b4c --- /dev/null +++ b/docs/2_building.md @@ -0,0 +1,26 @@ +# 🔨️ Building + +Build ReVanced CLI from source. + +## 📝 Requirements + +- Java Development Kit 11 (Azul Zulu JRE or OpenJDK) + +## 🏗️ Building + +To build ReVanced CLI, follow these steps: + +1. Clone the repository: + + ```bash + git clone git@github.com:ReVanced/revanced-cli.git + cd revanced-cli + ``` + +2. Build the project: + + ```bash + ./gradlew build + ``` + +After the build succeeds, the built JAR file will be located at `build/libs/revanced-cli--all.jar`. diff --git a/docs/README.md b/docs/README.md index 95a1656..5550101 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,9 @@ # 💻 Documentation and guides of ReVanced CLI -This documentation explains how to use [ReVanced CLI](https://github.com/revanced/revanced-cli). +This documentation contains topics around [ReVanced CLI](https://github.com/revanced/revanced-cli). ## 📖 Table of contents 1. [💼 Prerequisites](0_prerequisites.md) 2. [🛠️ Using ReVanced CLI](1_usage.md) +3. [🔨 Building ReVanced CLI](2_building.md)