From 4cdd9acd73e732c04263e11d6c0e172d58ccea3f Mon Sep 17 00:00:00 2001 From: KobeW50 <84587632+KobeW50@users.noreply.github.com> Date: Sat, 16 Sep 2023 06:38:06 -0400 Subject: [PATCH] docs(readme): add documentation and minor fixes (#1264) Co-authored-by: Pun Butrach --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f10008f3..89f41ea6 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,9 @@ You can obtain ReVanced Manager by downloading it from either [revanced.app/down 1. Android 8 or higher 2. Incompatible with certain ARMv7 devices +## 📃 Documentation +The documentation can be found [here](https://github.com/revanced/revanced-manager/tree/main/docs). + ## 🔴 Issues For suggestions and bug reports, open an issue [here](https://github.com/revanced/revanced-manager/issues/new/choose). @@ -19,14 +22,14 @@ For suggestions and bug reports, open an issue [here](https://github.com/revance [![Crowdin](https://badges.crowdin.net/revanced/localized.svg)](https://crowdin.com/project/revanced) -We're accepting translations on [Crowdin](https://translate.revanced.app) +We're accepting translations on [Crowdin](https://translate.revanced.app). ## 🛠️ 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](/docs/4_building.md) +3. Add your GitHub token in gradle.properties like [this](/docs/4_building.md) 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` +7. To build release APK run `flutter build apk`