📝 Updated Docs

This commit is contained in:
Nikhil Badyal
2022-11-02 22:08:09 +05:30
parent be42de0f4c
commit 5fb01a3ef9
+20 -29
View File
@@ -1,4 +1,4 @@
# Docker-Py-ReVanced
# 🤓Docker-Py-ReVanced
A little python script that will help you in building Revanced and Revanced-Extended [apps](#note)
@@ -8,7 +8,7 @@ Revanced Extended.
## Pre-Built APKs
You can get pre-built apks [here](https://t.me/revanced_apkss)
You can get pre-built apks [here](https://revanced_apkss.t.me/)
## Build Yourself
@@ -44,82 +44,73 @@ You can use any of the following methods to build.
4. If the building process is successful, youll get your APKs in the <br>
<img src="https://i.imgur.com/S5d7qAO.png" width="700" style="left">
<details>
<summary>🐳With Docker Compose</summary>
- 🐳With Docker Compose
1. Install Docker(Skip if already installed)
1. Install Docker(Skip if already installed)
```bash
curl -fsSL https://get.docker.com -o get-docker.sh
sh get-docker.sh
```
2. Grant Permissions with(Skip if already there)
2. Grant Permissions with(Skip if already there)
```bash
sudo usermod -a -G docker ec2-user
sudo usermod -a -G docker $USER
sudo chmod 777 /var/run/docker.sock
```
3. Install Docker compose(Skip if already installed or using **_`Docker Desktop`_**)
3. Install Docker compose(Skip if already installed or using **_`Docker Desktop`_**)
```bash
curl -L "https://github.com/docker/compose/releases/download/v2.10.2/docker-compose-$(uname -s)-$(uname -m)" \
-o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
```
4. Clone the repo
4. Clone the repo
```bash
git clone https://github.com/nikhilbadyal/docker-py-revanced
```
5. cd to the cloned repo
5. cd to the cloned repo
```bash
cd docker-py-revanced
```
6. Run script with
6. Run script with
```shell
docker-compose up
```
</details>
- 🐳With Docker
<details>
<summary>🐳With Docker</summary>
1. Install Docker(Skip if already installed)
1. Install Docker(Skip if already installed)
```bash
curl -fsSL https://get.docker.com -o get-docker.sh
sh get-docker.sh
```
2. Run script with
2. Run script with
```shell
docker run -v "$(pwd)"/apks:/app/apks/ nikhilbadyal/docker-py-revanced
```
You can pass below envs with `-e` flag.
</details>
- 🫠Without Docker
<details>
<summary>🫠Without Docker</summary>
1. Install Java17 (zulu preferred)
2. Install Python
3. Create virtual environment
1. Install Java17 (zulu preferred)
2. Install Python
3. Create virtual environment
```
python3 -m venv venv
```
4. Activate virtual environment
4. Activate virtual environment
```
source venv/bin/activate
```
5. Install Dependencies with
5. Install Dependencies with
```
pip install -r requirements.txt
```
6. Run the script with
6. Run the script with
```
python python main.py
```
</details>
### Note
## Note
(Pay attention to 3,4)<br>
By default, script build the version as recommended by Revanced team.