Skip to content

Commit 8f59d94

Browse files
committedDec 21, 2023
docs: Add building instructions
1 parent 3bcee04 commit 8f59d94

File tree

3 files changed

+30
-3
lines changed

3 files changed

+30
-3
lines changed
 

‎docs/0_prerequisites.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ To use ReVanced CLI, you will need to fulfill specific requirements.
44

55
## 🤝 Requirements
66

7-
- Java SDK 11 (Azul Zulu JDK or OpenJDK)
8-
- [Android Debug Bridge (adb)](https://developer.android.com/studio/command-line/adb) if you want to install the patched APK file on your device
7+
- Java Runtime Environment 11 (Azul Zulu JRE or OpenJDK)
8+
- [Android Debug Bridge (ADB)](https://developer.android.com/studio/command-line/adb) if you want to install the patched APK file on your device
99
- An ABI other than ARMv7 such as x86 or x86-64 (or a custom AAPT binary that supports ARMv7)
1010

1111
## ⏭️ Whats next

‎docs/2_building.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# 🔨️ Building
2+
3+
Build ReVanced CLI from source.
4+
5+
## 📝 Requirements
6+
7+
- Java Development Kit 11 (Azul Zulu JRE or OpenJDK)
8+
9+
## 🏗️ Building
10+
11+
To build ReVanced CLI, follow these steps:
12+
13+
1. Clone the repository:
14+
15+
```bash
16+
git clone git@github.com:ReVanced/revanced-cli.git
17+
cd revanced-cli
18+
```
19+
20+
2. Build the project:
21+
22+
```bash
23+
./gradlew build
24+
```
25+
26+
After the build succeeds, the built JAR file will be located at `build/libs/revanced-cli-<version>-all.jar`.

‎docs/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# 💻 Documentation and guides of ReVanced CLI
22

3-
This documentation explains how to use [ReVanced CLI](https://github.com/revanced/revanced-cli).
3+
This documentation contains topics around [ReVanced CLI](https://github.com/revanced/revanced-cli).
44

55
## 📖 Table of contents
66

77
1. [💼 Prerequisites](0_prerequisites.md)
88
2. [🛠️ Using ReVanced CLI](1_usage.md)
9+
3. [🔨 Building ReVanced CLI](2_building.md)

0 commit comments

Comments
 (0)
Please sign in to comment.