From df31e5ccd1b91681105a5a7fc0d26dae2bd40084 Mon Sep 17 00:00:00 2001 From: Aunali321 <48486084+Aunali321@users.noreply.github.com> Date: Sun, 9 Oct 2022 02:59:50 +0530 Subject: [PATCH] feat: add building from source instructions. --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 24da6e2c..b5a93fce 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,27 @@ The official ReVanced Manager based on Flutter. ## 🔽 Download -To download the Alpha version of Manager, go [here](https://github.com/revanced/revanced-manager/releases/latest) and install the provided APK file. +To download the Alpha version of Manager, go [here](https://github.com/revanced/revanced-manager/releases/latest) and install the provided APK file ## 🔴 Issues -For suggestions and bug reports, open an issue [here](https://github.com/revanced/revanced-manager/issues/new/choose). +For suggestions and bug reports, open an issue [here](https://github.com/revanced/revanced-manager/issues/new/choose) ## 💭 Discussion -If you wish to discuss the Manager, a thread has been made under the [#chat](https://discord.com/channels/952946952348270622/1002922226443632761) channel in the Discord server, please note that this thread may be temporary and may be removed in the future. +If you wish to discuss the Manager, a thread has been made under the [#development](https://discord.com/channels/952946952348270622/1002922226443632761) channel in the Discord server, please note that this thread may be temporary and may be removed in the future ## ⚠️ Disclaimer *Please note that even though we're releasing the Manager, it is an ALPHA version. Meaning there's a big chance that the Manager might not work at all for you.* -## Prerequisites -1. Android 8 or higher. -2. Does not work on armv7 -3. For YouTube and YouTube Music - Vanced MicroG(Only for non-root). +## 📝 Prerequisites +1. Android 8 or higher +2. Does not work on some armv7 devices +3. For YouTube and YouTube Music - Vanced MicroG(Only for non-root) + +## 🛠️ Building Manager from source +1. Setup flutter environment for your [platform](https://docs.flutter.dev/get-started/install) +2. Clone the repository locally +3. Add your github token in gradle.properties like [this](https://github.com/revanced/revanced-documentation/wiki/Building-from-source) +4. Open the project in terminal +5. Run `flutter pub get` in terminal +6. Then `flutter packages pub run build_runner build --delete-conflicting-outputs` (Must be done on each git pull) +7. To build release apk run `flutter build apk`