Skip to content

Commit aac3584

Browse files
committed
Update README.md
1 parent 6f91ac6 commit aac3584

File tree

1 file changed

+62
-1
lines changed

1 file changed

+62
-1
lines changed

README.md

Lines changed: 62 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,64 @@
11
# Revanced Auto Build
2-
> Auto build Revanced for individual 😎😎
2+
> Auto build *Revanced (non-root)* for individual with GitHub Actions 😎😎
33
4+
## Requirements
5+
- OS: Windows, MacOS or Linux.
6+
- Tools:
7+
- Python >= 3.10
8+
- JDK >= 17
9+
10+
## Setup
11+
- Step 1: Clone this repository
12+
```shell
13+
git clone https://github.com/hardingadonis/revanced-auto-build.git
14+
cd revanced-auto-build
15+
```
16+
- Step 2: Install **virtualenv**
17+
```shell
18+
pip install virtualenv
19+
```
20+
- Step 3: Install Python libraries
21+
```shell
22+
virtualenv .venv
23+
".venv/Scripts/activate"
24+
pip install -r requirements.txt
25+
```
26+
- Step 4: Run Python script
27+
```shell
28+
python auto-build.py
29+
```
30+
31+
## Development
32+
> Just for those who want to build more Revanced apps.
33+
34+
List all apps that Revanced support: [link](https://github.com/revanced/revanced-patches).
35+
36+
To add more app for building, check [packages.yml](packages.yml)
37+
38+
Template:
39+
```yaml
40+
<the package name>:
41+
- version: <your version that you want to build>
42+
- uptodown: <link to download APK file from uptodown>
43+
- exclude_options:
44+
- <option 1>
45+
- <option 2>
46+
```
47+
48+
For example:
49+
```yaml
50+
com.google.android.youtube:
51+
- version: 18.16.37
52+
- uptodown: https://youtube.en.uptodown.com/android/download/101361605
53+
- exclude_options:
54+
- vanced-microg-support
55+
```
56+
57+
58+
## License
59+
60+
GPL-3.0 License,
61+
62+
Copyright (c) 2023 [Minh Vương](https://github.com/hardingadonis).
63+
64+
This repository is forked from [n0k0m3/revanced-build-template](https://github.com/n0k0m3/revanced-build-template), that also under **GPL-3.0 License**.

0 commit comments

Comments
 (0)