From de58dff42313bcd93960289fc2dc06a6867bea34 Mon Sep 17 00:00:00 2001 From: Pun Butrach Date: Sat, 11 Nov 2023 17:56:28 +0700 Subject: [PATCH] docs: improve readme (#1484) --- CONTRIBUTING.md | 88 +++++++++++++++ README.md | 104 ++++++++++++++---- .../revanced-headline-vertical-dark.svg | 1 + .../revanced-headline-vertical-light.svg | 1 + assets/revanced-logo/revanced-logo-round.svg | 1 + 5 files changed, 174 insertions(+), 21 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 assets/revanced-headline/revanced-headline-vertical-dark.svg create mode 100644 assets/revanced-headline/revanced-headline-vertical-light.svg create mode 100644 assets/revanced-logo/revanced-logo-round.svg diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..d261a86a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,88 @@ +

+ + + + +
+ + +     + + + + + +     + + +     + + +     + + +     + + + + + +     + + + +
+
+ Continuing the legacy of Vanced +

+ +# 👋 Contribution guidelines + +This document describes how to contribute to ReVanced Manager. + +## 📖 Resources to help you get started + +* The [documentation](/docs/README.md) provides steps to build ReVanced Manager from source +* Our [backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on +* [Issues](https://github.com/ReVanced/revanced-manager/issues) are where we keep track of bugs and feature requests + +## 🙏 Submitting a feature request + +Features can be requested by opening an issue using the +[feature request issue template](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=feature-request&projects=&template=feature-issue.yml&title=feat%3A+%3Ctitle%3E). + +> [!NOTE] +> We may reject your request at the discretion of ReVanced Manager's maintainers, +> please provide good motivation for a request to be accepted. + +## 🐞 Submitting a bug report + +If you encounter a bug while using the ReVanced Manager app, open an issue using the +[bug report issue template](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=bug&projects=&template=bug-issue.yml&title=bug%3A+%3Ctitle%3E). + +## 📝 How to contribute + +> [!NOTE] +> We recommend that you discuss your changes with +> the maintainers of ReVanced Manager before contributing. +> This will help you determine whether your change is acceptable. + +1. Fork the repository and create a new branch based off the `dev` branch +2. Commit your changes +3. Open a pull request to the `dev` branch and reference issues that your pull request closes +4. The maintainers of ReVanced Manager will review and provide suggestions. + Once your pull request is approved and merged, it will be included in the next release of ReVanced Manager + +## 🤚 I want to contribute but don't know how to code + +Even if you don't know how to code, you can still contribute by +translating ReVanced Manager on [Crowdin](https://translate.revanced.app/). + +❤️ Thank you for considering contributing to ReVanced Manager. diff --git a/README.md b/README.md index 7e872198..a299cda2 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,97 @@ +

+ + + + +
+ + + + + +     + + + + + +     + + + + + +     + + + + + +     + + + + + +     + + + + + +     + + + + + + +
+
+ Continuing the legacy of Vanced +

+ # 💊 ReVanced Manager -The official ReVanced Manager based on Flutter. +[![GitHub last commit](https://img.shields.io/github/last-commit/ReVanced/revanced-manager)](https://github.com/ReVanced/revanced-manager/commits "") +[![GitHub commit activity](https://img.shields.io/github/commit-activity/w/ReVanced/revanced-manager)](https://github.com/ReVanced/revanced-manager/commits "") + +ReVanced Manager is an Android application that uses ReVanced Patcher to add, remove, and modify existing functionalities in Android applications. + +## 💪 Features + +We provide the some of the features are: + +* 📱 **Portable**: ReVanced Patcher that fit in your pocket; +* 🤗 **Intuitive UI**: Help you manage your patched applications *intuitively*; +* 🛠️ **Customization**: Patch with third-party sources; +* ✨ And a **lot more!** ## 🔽 Download -You can obtain ReVanced Manager by downloading it from either [revanced.app/download](https://revanced.app/download) or [GitHub Releases](https://github.com/ReVanced/revanced-manager/releases) +You can get ReVanced Manager by downloading from [ReVanced site](https://revanced.app/download) or [GitHub releases](https://github.com/ReVanced/revanced-manager/releases). -## 📝 Prerequisites +## 📚 Everything else -1. Android 8 or higher -2. Incompatible with certain ARMv7 devices +### 📄 Documentation -## 📃 Documentation -The documentation can be found [here](https://github.com/revanced/revanced-manager/tree/main/docs). +Documentation on how to use the application is available [here](/docs/README.md). -## 🔴 Issues +### 👋 Contributing -For suggestions and bug reports, open an issue [here](https://github.com/revanced/revanced-manager/issues/new/choose). +Thank you for considering contributing to ReVanced Manager, you can find the contribution guidelines [here](/CONTRIBUTING.md). -## 🌐 Translation +### 🔴 Issues -[![Crowdin](https://badges.crowdin.net/revanced/localized.svg)](https://crowdin.com/project/revanced) +For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/choose). -We're accepting translations on [Crowdin](https://translate.revanced.app). +## ⚖️ License -## 🛠️ 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) -4. Open the project in terminal -5. Run `flutter pub get` in terminal -6. Then `dart run build_runner build --delete-conflicting-outputs` (Must be done on each git pull) -7. To build release APK run `flutter build apk` +ReVanced Manager adopts the [GNU General Public License 3.0](/LICENSE), [tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3): You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions. diff --git a/assets/revanced-headline/revanced-headline-vertical-dark.svg b/assets/revanced-headline/revanced-headline-vertical-dark.svg new file mode 100644 index 00000000..a59bfb50 --- /dev/null +++ b/assets/revanced-headline/revanced-headline-vertical-dark.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/revanced-headline/revanced-headline-vertical-light.svg b/assets/revanced-headline/revanced-headline-vertical-light.svg new file mode 100644 index 00000000..3c5eeccc --- /dev/null +++ b/assets/revanced-headline/revanced-headline-vertical-light.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/revanced-logo/revanced-logo-round.svg b/assets/revanced-logo/revanced-logo-round.svg new file mode 100644 index 00000000..901e1914 --- /dev/null +++ b/assets/revanced-logo/revanced-logo-round.svg @@ -0,0 +1 @@ + \ No newline at end of file