-
-
Notifications
You must be signed in to change notification settings - Fork 763
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4715fa3
commit 3f8d357
Showing
5 changed files
with
174 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| <p align="center"> | ||
| <picture> | ||
| <source | ||
| width="256px" | ||
| media="(prefers-color-scheme: dark)" | ||
| srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg" | ||
| > | ||
| <img | ||
| width="256px" | ||
| src="assets/revanced-headline/revanced-headline-vertical-light.svg" | ||
| > | ||
| </picture> | ||
| <br> | ||
| <a href="https://revanced.app/"> | ||
| <img height="24px" src="assets/revanced-logo/revanced-logo-round.svg" /> | ||
| </a> | ||
| <a href="https://github.com/ReVanced"> | ||
| <picture> | ||
| <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" /> | ||
| <img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" /> | ||
| </picture> | ||
| </a> | ||
| <a href="http://revanced.app/discord"> | ||
| <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" /> | ||
| </a> | ||
| <a href="https://reddit.com/r/revancedapp"> | ||
| <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" /> | ||
| </a> | ||
| <a href="https://t.me/app_revanced"> | ||
| <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" /> | ||
| </a> | ||
| <a href="https://x.com/revancedapp"> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png"> | ||
| <img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" /> | ||
| </picture> | ||
| </a> | ||
| <a href="https://www.youtube.com/@ReVanced"> | ||
| <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" /> | ||
| </a> | ||
| <br> | ||
| <br> | ||
| Continuing the legacy of Vanced | ||
| </p> | ||
|
|
||
| # 👋 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,97 @@ | ||
| <p align="center"> | ||
| <picture> | ||
| <source | ||
| width="256px" | ||
| media="(prefers-color-scheme: dark)" | ||
| srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg" | ||
| > | ||
| <img | ||
| width="256px" | ||
| src="assets/revanced-headline/revanced-headline-vertical-light.svg" | ||
| > | ||
| </picture> | ||
| <br> | ||
| <a href="https://revanced.app/"> | ||
| <picture> | ||
| <source height="24px" media="(prefers-color-scheme: dark)" srcset="assets/revanced-logo/revanced-logo-round.svg" /> | ||
| <img height="24px" src="assets/revanced-logo/revanced-logo-round.svg" /> | ||
| </picture> | ||
| </a> | ||
| <a href="https://github.com/ReVanced"> | ||
| <picture> | ||
| <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" /> | ||
| <img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" /> | ||
| </picture> | ||
| </a> | ||
| <a href="http://revanced.app/discord"> | ||
| <picture> | ||
| <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" /> | ||
| <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" /> | ||
| </picture> | ||
| </a> | ||
| <a href="https://reddit.com/r/revancedapp"> | ||
| <picture> | ||
| <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" /> | ||
| <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" /> | ||
| </picture> | ||
| </a> | ||
| <a href="https://t.me/app_revanced"> | ||
| <picture> | ||
| <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" /> | ||
| <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" /> | ||
| </picture> | ||
| </a> | ||
| <a href="https://x.com/revancedapp"> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png"> | ||
| <img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" /> | ||
| </picture> | ||
| </a> | ||
| <a href="https://www.youtube.com/@ReVanced"> | ||
| <picture> | ||
| <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" /> | ||
| <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" /> | ||
| </picture> | ||
| </a> | ||
| <br> | ||
| <br> | ||
| Continuing the legacy of Vanced | ||
| </p> | ||
|
|
||
| # 💊 ReVanced Manager | ||
|
|
||
| The official ReVanced Manager based on Flutter. | ||
| [](https://github.com/ReVanced/revanced-manager/commits "") | ||
| [](https://github.com/ReVanced/revanced-manager/commits "") | ||
|
|
||
| ## 🔽 Download | ||
| ReVanced Manager is an Android application that uses ReVanced Patcher to add, remove, and modify existing functionalities in Android applications. | ||
|
|
||
| ## 💪 Features | ||
|
|
||
| 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) | ||
| 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 | ||
|
|
||
| ## 📝 Prerequisites | ||
| You can get ReVanced Manager by downloading from [ReVanced site](https://revanced.app/download) or [GitHub releases](https://github.com/ReVanced/revanced-manager/releases). | ||
|
|
||
| 1. Android 8 or higher | ||
| 2. Incompatible with certain ARMv7 devices | ||
| ## 📚 Everything else | ||
|
|
||
| ## 📃 Documentation | ||
| The documentation can be found [here](https://github.com/revanced/revanced-manager/tree/main/docs). | ||
| ### 📄 Documentation | ||
|
|
||
| ## 🔴 Issues | ||
| Documentation on how to use the application is available [here](/docs/README.md). | ||
|
|
||
| For suggestions and bug reports, open an issue [here](https://github.com/revanced/revanced-manager/issues/new/choose). | ||
| ### 👋 Contributing | ||
|
|
||
| ## 🌐 Translation | ||
| Thank you for considering contributing to ReVanced Manager, you can find the contribution guidelines [here](/CONTRIBUTING.md). | ||
|
|
||
| [](https://crowdin.com/project/revanced) | ||
| ### 🔴 Issues | ||
|
|
||
| We're accepting translations on [Crowdin](https://translate.revanced.app). | ||
| For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/choose). | ||
|
|
||
| ## 🛠️ Building Manager from source | ||
| ## ⚖️ License | ||
|
|
||
| 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. |
Oops, something went wrong.