diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d4cc28bf92..f371a7002c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,7 +60,8 @@ # 👋 Contribution guidelines -This document describes how to contribute to ReVanced Manager. +Welcome to contribution guidelines, this document contains +everything you'll need to contribute to ReVanced Manager. ## 📖 Resources to help you get started @@ -74,8 +75,8 @@ 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. +> Requests can be accepted or rejected at the discretion of maintainers of ReVanced Manager. +> Good motivation has to be provided for a request to be accepted. ## 🐞 Submitting a bug report @@ -84,20 +85,22 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using ## 📝 How to contribute -> [!NOTE] +> [!TIP] > 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. Make sure that the commit name are clear and concise as possible and 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 +1. Fork the repository and create your branch from `dev` +2. Commit your changes +3. Submit a pull request to the `dev` branch of the repository and reference issues that your pull request closes in the description of your pull request +4. Our team will review your pull request and provide feedback. Once your pull request is approved, it will be merged into the `dev` branch and 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/). +translating ReVanced Manager on [Crowdin](https://translate.revanced.app/) +or sponsor us at [GitHub Sponsor](https://github.com/sponsors/ReVanced) and [OpenCollective](https://opencollective.com/ReVanced). -❤️ Thank you for considering contributing to ReVanced Manager. +❤️ Thank you for considering contributing to ReVanced Manager, +ReVanced diff --git a/README.md b/README.md index 6f904cde86..fc8f6ad00e 100644 --- a/README.md +++ b/README.md @@ -60,38 +60,48 @@ # 💊 ReVanced Manager -[![GitHub last commit](https://img.shields.io/github/last-commit/ReVanced/revanced-manager/compose-dev)](https://github.com/ReVanced/revanced-manager/commits/compose-dev "") -[![GitHub commit activity](https://img.shields.io/github/commit-activity/w/ReVanced/revanced-manager/compose-dev)](https://github.com/ReVanced/revanced-manager-compose/commits/compose-dev "") +[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ReVanced/revanced-manager/release.yml)](https://github.com/ReVanced/revanced-manager/actions/workflows/release.yml) +[![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)](#️-license) -ReVanced Manager is an Android application that uses ReVanced Patcher to add, remove, and modify existing functionalities in Android applications. +Application to use ReVanced on Android + +## ❓ About + +ReVanced Manager is an application that uses [ReVanced Patcher](https://github.com/revanced/revanced-patcher) to patch Android apps. ## 💪 Features -We provide the some of the features are: +Some of the features ReVanced Manager provides are: -* 📱 **Portable**: ReVanced Patcher that fit in your pocket; -* 🤗 **Intuitive UI**: Help you manage your patched applications with easy-to-use interface; -* 🛠️ **Customization**: Patch with third-party sources; -* ✨ And a **lot more!** +- 💉 **Patch apps**: Apply any patch of your choice to Android apps +- 📱 **Portable**: ReVanced Patcher that fits in your pocket +- 🤗 **Simple UI**: Quickly understand the ins and outs of ReVanced Manager +- 🛠️ **Customization**: Configurable API, custom sources, language, signing keystore, theme and more ## 🔽 Download -You can get ReVanced Manager by downloading from [ReVanced site](https://revanced.app/download) or [GitHub releases](https://github.com/ReVanced/revanced-manager/releases). +You can get ReVanced Manager the most recent version of by downloading from +the [ReVanced site](https://revanced.app/download) or [GitHub releases](https://github.com/ReVanced/revanced-manager/releases/latest). + +Learn how to use ReVanced Manager by following the [documentation](/docs). ## 📚 Everything else -### 📄 Documentation +### 📙 Contributing -Documentation on how to use the application is available [here](/docs/README.md). +You can find the contribution guidelines [here](CONTRIBUTING.md). +Thank you for considering contributing to ReVanced Manager. -### 👋 Contributing +### 🛠️ Building -Thank you for considering contributing to ReVanced Manager, you can find the contribution guidelines [here](/CONTRIBUTING.md). +To build a ReVanced Manager, you can follow the [documentation](/docs). -### 🔴 Issues +### 📄 Documentation -For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/choose). +You can find the documentation for ReVanced Manager [here](/docs). ## ⚖️ License -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. +ReVanced Manager is licensed under the GPLv3 license. Please see the [license file](LICENSE) for more information. +[tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3) you may copy, distribute and modify ReVanced Manager as long as you track changes/dates in source files. +Any modifications to ReVanced Manager must also be made available under the GPL, along with build & install instructions. diff --git a/docs/0_prerequisites.md b/docs/0_prerequisites.md index 9d86cd5438..773e11d373 100644 --- a/docs/0_prerequisites.md +++ b/docs/0_prerequisites.md @@ -1,10 +1,19 @@ # 💼 Prerequisites -In order to use ReVanced Manager, certain requirements must be met. +To use ReVanced Manager, an certain requirements had to be met. ## 🤝 Requirements -- An Android device running Android 8 or higher +- Android device running Android 8.0 or higher +- System that support running at least arm64-v8a, armeabi-v7a, x86_64, or x86 application + +### Additional Requirements + +> [!NOTE] +> These requirement(s) are not required to be met, +> but will provide extra functionalit(ies) to ReVanced Manager. + +- Rooted Android device with [KernelSU](https://github.com/tiann/KernelSU) v1.0.1 or [Magisk](https://github.com/topjohnwu/Magisk) v25.2 or higher ## ⏭️ What's next diff --git a/docs/1_installation.md b/docs/1_installation.md index bcf1a3f5e6..0a95577e77 100644 --- a/docs/1_installation.md +++ b/docs/1_installation.md @@ -1,10 +1,13 @@ # ⬇️ Installation -In order to use ReVanced on your Android device, ReVanced Manager must be installed. +To use ReVanced on your Android device, ReVanced Manager have to be install, +refer to the [Prerequisites](0_prerequisites.md) if haven't already. ## ✅ Installation steps -1. Download the latest version of ReVanced Manager from [here](https://github.com/ReVanced/revanced-manager/releases/latest) +1. Get the latest version of ReVanced Manager from + the [ReVanced site](https://revanced.app/download) + or [GitHub releases](https://github.com/ReVanced/revanced-manager/releases/latest). 2. Install ReVanced Manager ## ⏭️ What's next