diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..413c4ca735 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,106 @@ +

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

+ +# 👋 Contribution guidelines + +Welcome to contribution guidelines, this document contains +everything you'll need 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] +> 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 + +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 + +> [!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 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/) +or sponsor us at [GitHub Sponsor](https://github.com/sponsors/ReVanced) and [Open Collective](https://opencollective.com/ReVanced). + +❤️ Thank you for considering contributing to ReVanced Manager, +ReVanced diff --git a/README.md b/README.md index c742bcab29..fc8f6ad00e 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,107 @@ -# ReVanced Manager (Compose Rewrite) - -[![GitHub license](https://img.shields.io/github/license/revanced/revanced-manager)](../../blob/main/LICENSE) -[![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/commits/compose-dev) - -_(Yet another)_ rewrite of the ReVanced Manager using Kotlin and Jetpack Compose. - -## Design system - -In this rewrite, we are adopting the latest Material Design principles and guidelines by using Material 3 and Material You. - -Material Design is a design system developed by Google that provides a unified visual language for building beautiful and consistent user interfaces across all platforms and devices. Material You is an extension of Material Design that provides even more customization options for users, making it possible for them to personalize their device and create a unique look and feel. - -### Why Material 3? - -* **Consistent design language** -* **Improved accessibility** -* **Better user experience** - -By using Material 3 and Material You, we are ensuring that the app's user interface is consistent, customizable, accessible, and engaging for our users. This will help to improve the overall user experience and increase user satisfaction with the the manager. - -## Technology stack - -* Kotlin: Kotlin is a modern and concise programming language that is fully interoperable with Java and provides improved safety, readability, and maintainability compared to Java. -* Jetpack Compose: Jetpack Compose is a modern UI toolkit for Android development that allows developers to build beautiful and performant user interfaces using declarative programming. It provides a unified and efficient way of building UI that is well-integrated with the Android framework. - -## Why Kotlin and Compose? - -* **Improved safety:** Kotlin provides improved safety compared to Java, which reduces the likelihood of common programming mistakes that can cause security vulnerabilities or crashes. -* **Concise and readable code:** Kotlin's concise syntax and expressive type system make the code more readable, which makes it easier for developers to understand and maintain the codebase. -* **Better performance:** Jetpack Compose uses the power of the Android framework to provide smooth and fast performance, which enhances the user experience. -* **Modern and efficient UI development:** Jetpack Compose provides a modern and efficient way of building UI, which makes it easier for developers to create beautiful and performant user interfaces. +

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

+ +# 💊 ReVanced Manager + +[![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) + +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 + +Some of the features ReVanced Manager provides are: + +- 💉 **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 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 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). -## 📝 Prerequisites +## 📚 Everything else -For a list of prerequisites, refer to [docs/0_prerequisites.md](docs/0_prerequisites.md) +### 📙 Contributing -## 🔴 Issues +You can find the contribution guidelines [here](CONTRIBUTING.md). +Thank you for considering contributing to ReVanced Manager. -For suggestions and bug reports, open an issue [here](https://github.com/revanced/revanced-manager/issues/new/choose). +### 🛠️ Building -## 🌐 Translation +To build a ReVanced Manager, you can follow the [documentation](/docs). -[![Crowdin](https://badges.crowdin.net/revanced/localized.svg)](https://crowdin.com/project/revanced) +### 📄 Documentation -We're accepting translations on [Crowdin](https://translate.revanced.app) +You can find the documentation for ReVanced Manager [here](/docs). -## 🛠️ Building Manager from source +## ⚖️ License -For instructions on how to build ReVanced Manager from source, refer to [docs/4_building.md](docs/4_building.md) \ No newline at end of file +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/SECURITY.md b/SECURITY.md index b8c6fd144b..8af902fc3d 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -13,8 +13,8 @@
- - + +     @@ -64,15 +64,17 @@ This document describes how to report security vulnerabilities for ReVanced Mana ## 🚨 Reporting a Vulnerability -Please open an issue in our [advisory tracker](https://github.com/ReVanced/revanced-manager/security/advisories/new) or reach out privately to us on [Discord](https://discord.gg/revanced). +Please open an issue in our [advisory tracker](https://github.com/ReVanced/revanced-manager/security/advisories/new) +or reach out privately to us on [Discord](https://discord.gg/revanced). -If a vulnerability is confirmed and accepted, you can join our [Discord](https://discord.gg/revanced) server to receive a special contributor role. +If a vulnerability is confirmed and accepted, they will be published and +you can join our [Discord](https://discord.gg/revanced) server to receive a +special contributor role. ### ⏳ Supported Versions -| Version | Branch | Supported | -| ------- | ------------|------------------- | -| v1.18.0 | main | :white_check_mark: | -| latest | dev | :white_check_mark: | -| latest | compose-dev | :white_check_mark: | - +| Version | Branch | Supported | +| --------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------------ | +| ![Latest stable release](https://img.shields.io/github/v/release/ReVanced/revanced-manager?style=for-the-badge "Latest stable release") | main | :white_check_mark: | +| ![Latest version](https://img.shields.io/badge/version-latest-brightgreen?style=for-the-badge "Latest version") | dev | :white_check_mark: | +| ![Latest version](https://img.shields.io/badge/version-latest-brightgreen?style=for-the-badge "Latest version") | compose-dev | :white_check_mark: | diff --git a/assets/revanced-logo/revanced-logo-round.svg b/assets/revanced-logo/revanced-logo.svg similarity index 100% rename from assets/revanced-logo/revanced-logo-round.svg rename to assets/revanced-logo/revanced-logo.svg diff --git a/docs/0_prerequisites.md b/docs/0_prerequisites.md index 9d86cd5438..eab3b19b95 100644 --- a/docs/0_prerequisites.md +++ b/docs/0_prerequisites.md @@ -1,10 +1,18 @@ # 💼 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. + +- Rooted Android device with latest version of [KernelSU](https://github.com/tiann/KernelSU) or [Magisk](https://github.com/topjohnwu/Magisk) ## ⏭️ What's next diff --git a/docs/1_installation.md b/docs/1_installation.md index d4c08984af..67e3518cda 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 +## 🪜 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 diff --git a/docs/2_1_patching.md b/docs/2_1_patching.md index 7203affa2a..2cb565e9c2 100644 --- a/docs/2_1_patching.md +++ b/docs/2_1_patching.md @@ -11,7 +11,8 @@ The following pages will guide you through using ReVanced Manager to patch apps. 5. Select the patches you want to apply 6. Tap the Patch button 7. Tap on the **Install** button - > **Note**: If you are rooted, you can mount the patched app on top of the original app.[^3] + > [!Note] + > If you are rooted, you can mount the patched app on top of the original app.[^3] > Optionally, you may export the patched app to storage using the options in the top right corner. [^1]: Non-root users may be prompted to select an APK from storage, in which case you have to source the APK file yourself. ReVanced does not provide any APK files. diff --git a/docs/2_2_managing.md b/docs/2_2_managing.md index 29ec56fc4f..c72a0cd275 100644 --- a/docs/2_2_managing.md +++ b/docs/2_2_managing.md @@ -6,7 +6,9 @@ After patching an app, you may want to manage it. This page will guide you throu 1. Navigate to the Apps tab from the top navigation bar 2. Select the app you want to manage + 3. + ## ⏭️ What's next The next page will bring you back to the usage page. diff --git a/docs/3_troubleshooting.md b/docs/3_troubleshooting.md index 5a860c6b12..5ac930e81f 100644 --- a/docs/3_troubleshooting.md +++ b/docs/3_troubleshooting.md @@ -23,9 +23,3 @@ In case you encounter any issues while using ReVanced Manager, please refer to t - 🚨 Patched app crashes on launch Select the **Default** button when choosing patches. - -## ⏭️ What's next - -The next page will teach you how to build ReVanced Manager from source. - -Continue: [🔨 Building from source](4_building.md) diff --git a/docs/4_building.md b/docs/4_building.md deleted file mode 100644 index 56917e5fad..0000000000 --- a/docs/4_building.md +++ /dev/null @@ -1,38 +0,0 @@ -# 🛠️ Building from source - -This page will guide you through building ReVanced Manager from source. - -1. Download Java SDK 17 ([Azul JDK](https://www.azul.com/downloads/?version=java-17-lts&package=jdk#zulu) or [OpenJDK](https://jdk.java.net/java-se-ri/17)) and add it to path - -2. Clone the repository - - ```sh - git clone https://github.com/revanced/revanced-manager.git && cd revanced-manager - ``` - -3. Create a GitHub personal access token with the `read:packages` scope [here](https://github.com/settings/tokens/new?scopes=read:packages&description=ReVanced) - -4. Add your GitHub username and the token to `~/.gradle/gradle.properties` - - ```properties - gpr.user = YourUsername - gpr.key = ghp_longrandomkey - ``` - -5. Set the `sdk.dir` property in `local.properties` to your Android SDK location - - ```properties - sdk.dir = /path/to/android/sdk - ``` - -6. Build the APK - - Debug: - ```sh - ./gradlew assembleDebug - ``` - - Release: - ```sh - ./gradlew assembleRelease -Psign - ``` diff --git a/docs/README.md b/docs/README.md index af2926b6c1..f6ae368a56 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # 💊 ReVanced Manager -This documentation explains how to use [ReVanced Manager](https://github.com/revanced/revanced-manager). +This documentation explains how to use [ReVanced Manager](https://github.com/ReVanced/revanced-manager). ## 📖 Table of contents @@ -12,7 +12,6 @@ This documentation explains how to use [ReVanced Manager](https://github.com/rev 3. [🔄 Updating ReVanced Manager](2_3_updating.md) 4. [⚙️ Configuring ReVanced Manager](2_4_settings.md) 3. [❔ Troubleshooting](3_troubleshooting.md) -4. [🔨 Building from source](4_building.md) ## ⏭️ Start here