mirror of
https://github.com/revanced/revanced-cli.git
synced 2025-01-14 21:17:32 +01:00
docs: Add building instructions
This commit is contained in:
parent
3bcee04a7d
commit
8f59d94dc7
@ -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
|
||||
|
26
docs/2_building.md
Normal file
26
docs/2_building.md
Normal file
@ -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-<version>-all.jar`.
|
@ -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)
|
||||
|
Loading…
x
Reference in New Issue
Block a user