diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..2af7a944ba --- /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. 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 + +## 🤚 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 c742bcab29..d99ca437aa 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,97 @@ -# 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 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 "") + +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 with easy-to-use interface; +* 🛠️ **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 -For a list of prerequisites, refer to [docs/0_prerequisites.md](docs/0_prerequisites.md) +### 📄 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). -[![Crowdin](https://badges.crowdin.net/revanced/localized.svg)](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 -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 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 0000000000..a59bfb50bf --- /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 0000000000..3c5eeccc70 --- /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 0000000000..901e1914b4 --- /dev/null +++ b/assets/revanced-logo/revanced-logo-round.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/1_installation.md b/docs/1_installation.md index d4c08984af..bcf1a3f5e6 100644 --- a/docs/1_installation.md +++ b/docs/1_installation.md @@ -4,7 +4,7 @@ In order to use ReVanced on your Android device, ReVanced Manager must be instal ## ✅ Installation steps -1. Download the latest version of ReVanced Manager from [here](https://github.com/revanced/revanced-manager/releases/latest) +1. Download the latest version of ReVanced Manager from [here](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