diff --git a/README.md b/README.md index e41ce82..922d48a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,64 @@ # Revanced Auto Build -> Auto build Revanced for individual 😎😎 +> Auto build *Revanced (non-root)* for individual with GitHub Actions 😎😎 +## Requirements +- OS: Windows, MacOS or Linux. +- Tools: + - Python >= 3.10 + - JDK >= 17 + +## Setup +- Step 1: Clone this repository +```shell +git clone https://github.com/hardingadonis/revanced-auto-build.git +cd revanced-auto-build +``` +- Step 2: Install **virtualenv** +```shell +pip install virtualenv +``` +- Step 3: Install Python libraries +```shell +virtualenv .venv +".venv/Scripts/activate" +pip install -r requirements.txt +``` +- Step 4: Run Python script +```shell +python auto-build.py +``` + +## Development +> Just for those who want to build more Revanced apps. + +List all apps that Revanced support: [link](https://github.com/revanced/revanced-patches). + +To add more app for building, check [packages.yml](packages.yml) + +Template: +```yaml +: + - version: + - uptodown: + - exclude_options: + -