From e7b94868d6f98934b23576094c203f01b9bc39ed Mon Sep 17 00:00:00 2001 From: Pun Butrach Date: Sun, 8 Oct 2023 16:47:28 +0700 Subject: [PATCH 01/55] docs: merge branding to readme (SEE TODO) TODO: --- README.md | 46 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 45 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1a48684176..6c30402082 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,47 @@ +

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

+ # ReVanced Manager (Compose Rewrite) [![GitHub license](https://img.shields.io/github/license/revanced/revanced-manager)](../../blob/main/LICENSE) @@ -52,4 +96,4 @@ We're accepting translations on [Crowdin](https://translate.revanced.app) ## ๐Ÿ› ๏ธ Building Manager from source -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 +For instructions on how to build ReVanced Manager from source, refer to [docs/4_building.md](docs/4_building.md) From 676eb1e9e2a492fb46816e5aa5d206f84c665406 Mon Sep 17 00:00:00 2001 From: Pun Butrach Date: Mon, 9 Oct 2023 17:09:34 +0700 Subject: [PATCH 02/55] docs: part 2 --- README.md | 63 +++++++++++++++++++------------------------------------ 1 file changed, 22 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 6c30402082..6a90fb6fb8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ + +

-# 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-compose/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? +# ๐Ÿ’Š ReVanced Manager (Compose) -* **Consistent design language** -* **Improved accessibility** -* **Better user experience** +> ![IMPORTANT] +> This is a rewrite of ReVanced Manager in Kotlin Compose. -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. +ReVanced Manager is an Android application that uses ReVanced Patcher to add, remove, and modify existing functionalities in Android applications -## 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. +[![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-compose/commits/compose-dev) ## ๐Ÿ”ฝ 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) -## ๐Ÿ“ Prerequisites - -For a list of prerequisites, refer to [docs/0_prerequisites.md](docs/0_prerequisites.md) + ## ๐Ÿ”ด Issues -For suggestions and bug reports, open an issue [here](https://github.com/revanced/revanced-manager/issues/new/choose). - -## ๐ŸŒ Translation - -[![Crowdin](https://badges.crowdin.net/revanced/localized.svg)](https://crowdin.com/project/revanced) - -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/new/choose) with ReVanced Manager Compose label. ## ๐Ÿ› ๏ธ Building Manager from source -For instructions on how to build ReVanced Manager from source, refer to [docs/4_building.md](docs/4_building.md) +1. Clone the ReVanced Manager's repository and move into project's root directory. +2. Create a GitHub personal access token with the `read:packages` scope [here](https://github.com/settings/tokens/new?scopes=read:packages&description=ReVanced). +3. Add your GitHub username and the token to `gradle.properties`. + ```properties + gpr.user = YourUsername + gpr.key = ghp_longrandomkey + ``` +5. Compile the APK. + ```bash + gradlew assembleRelease + ``` From 67603f64cdaa75d6b884f00e9325cdc24404347f Mon Sep 17 00:00:00 2001 From: Pun Butrach Date: Sat, 21 Oct 2023 16:09:55 +0700 Subject: [PATCH 03/55] docs: part 2.1 --- README.md | 31 +++++-------------------------- 1 file changed, 5 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 6a90fb6fb8..32374a58b0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ - -

-# ๐Ÿ’Š ReVanced Manager (Compose) - -> ![IMPORTANT] -> This is a rewrite of ReVanced Manager in Kotlin Compose. - -ReVanced Manager is an Android application that uses ReVanced Patcher to add, remove, and modify existing functionalities in Android applications - -[![GitHub license](https://img.shields.io/github/license/ReVanced/revanced-manager)](../../blob/main/LICENSE) +# ๐Ÿ’Š 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) -## ๐Ÿ”ฝ Download +ReVanced Manager is an Android application that uses ReVanced Patcher to add, remove, and modify existing functionalities in Android applications +## ๐Ÿ”ฝ 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) - +## ๐Ÿ“„ Documentation +Step on how to use the application and compile are available [here](/docs/README.md). ## ๐Ÿ”ด Issues - For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/new/choose) with ReVanced Manager Compose label. -## ๐Ÿ› ๏ธ Building Manager from source - -1. Clone the ReVanced Manager's repository and move into project's root directory. -2. Create a GitHub personal access token with the `read:packages` scope [here](https://github.com/settings/tokens/new?scopes=read:packages&description=ReVanced). -3. Add your GitHub username and the token to `gradle.properties`. - ```properties - gpr.user = YourUsername - gpr.key = ghp_longrandomkey - ``` -5. Compile the APK. - ```bash - gradlew assembleRelease - ``` From 85c6e7283d54ded8b6957f1d9c956b9aba54dcef Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 16:21:19 +0700 Subject: [PATCH 04/55] docs: add ReVanced assets --- assets/revanced-headline/revanced-headline-vertical-dark.svg | 1 + assets/revanced-headline/revanced-headline-vertical-light.svg | 1 + assets/revanced-logo/revanced-logo-round.svg | 1 + 3 files changed, 3 insertions(+) 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/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 From 26b9652135433fc831687433c4059390ec25e45e Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 16:38:29 +0700 Subject: [PATCH 05/55] docs: part 3 --- CONTRIBUTING.md | 85 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 4 +-- 2 files changed, 87 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..d44fefaa99 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,85 @@ +

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

+ +# ๐Ÿ“™ Contributing guidelines +This document describes how to contribute to ReVanced Manager. + +## ๐Ÿ“– Resources to help you get started +* The [documentation](/docs/README.md) provides the steps by steps tutorial to compile ReVanced Manager from scratch +* [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-patches/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). + +> [!NOTE] +> We may rejected your request at the discretion of maintainers, +> please provides 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). + +## ๐Ÿ“ How to contribute + +> [!NOTE] +> It's worth noting that we recommended 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. Make sure that the commit name are clear and concise as possible and commit your changes. + If you have never contributed to this repository before, it's recommended to follow the rules in the [documentation](/docs/README.md) +3. Open a pull request to the `dev` branch and reference issues with `fix: #No.` if needed. +4. The maintainers of ReVanced Manager will review and provide suggestions. + Once your PR 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 + +We accept translation at Crowdin + + + +โค๏ธ Thank you for considering contributing to ReVanced Manager diff --git a/README.md b/README.md index 32374a58b0..e90ec587ce 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@
- +     @@ -32,7 +32,7 @@ - +     From 830a666a5877fc4eb67b00437f83502450421d06 Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 16:58:45 +0700 Subject: [PATCH 06/55] docs: part 4 --- CONTRIBUTING.md | 16 ++++++++++++---- README.md | 11 +++++++++++ 2 files changed, 23 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d44fefaa99..9dc108643b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,13 +42,21 @@ Continuing the legacy of Vanced

-# ๐Ÿ“™ Contributing guidelines +# ๐Ÿ‘‹ Contributing guidelines This document describes how to contribute to ReVanced Manager. +## ๐Ÿ’ฌ Community Engagement rules +We pledge to create a nice enviroment to everyone in the ReVanced community, +please follow these rules so we can help reach our goal! + +1. ๐Ÿค— **Be friendly**: If there's a disagreement, don't approach them with aggressive tone! +2. ๐Ÿ’ฌ **Be informative**: If you thinks that the additions or deletion of something is a bad idea, try to be desciptive of why you think this is a bad idea! +3. ๐Ÿ“œ **Follow GitHub Community Guidelines**: These 2 steps above are sufficient enough, but it's recommended that you read the [GitHub's Community Guidelines](https://docs.github.com/en/site-policy/github-terms/github-community-guidelines) + ## ๐Ÿ“– Resources to help you get started * The [documentation](/docs/README.md) provides the steps by steps tutorial to compile ReVanced Manager from scratch * [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-patches/issues) are where we keep track of bugs and feature requests +* [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 @@ -77,8 +85,8 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using Once your PR 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 - -We accept translation at Crowdin +Even if you don't know how to code, you can still help us by +translate the ReVanced Manager application at Crowdin, or spread loves around the community! diff --git a/README.md b/README.md index e90ec587ce..8b25be0f91 100644 --- a/README.md +++ b/README.md @@ -46,14 +46,25 @@ [![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) +## โ“ About 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: +* ๐Ÿ“ฑ ReVanced Patcher that fit in your pocket! +* ๐Ÿค— Friendly & initutive UI to help you manage your patched applications! +* ๐Ÿ› ๏ธ Lot's of customisation to patch using 3rd-party sources and integration! +* โœจ 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) ## ๐Ÿ“„ Documentation Step on how to use the application and compile are available [here](/docs/README.md). +## ๐Ÿ‘‹ Contributing +You can find the contributing guidelines [here](/CONTRIBUTING.md), Thanks for consider contributing to ReVanced Manager! + ## ๐Ÿ”ด Issues For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/new/choose) with ReVanced Manager Compose label. From 949b1dad0eb47763aa5ee2bf1345733da3199a30 Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 17:03:28 +0700 Subject: [PATCH 07/55] docs: part 4.1 --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 8b25be0f91..03b3942a89 100644 --- a/README.md +++ b/README.md @@ -60,11 +60,10 @@ We provide the some of the features are: 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) ## ๐Ÿ“„ Documentation -Step on how to use the application and compile are available [here](/docs/README.md). +Step on how to compile & use the application are available [here](/docs/README.md). ## ๐Ÿ‘‹ Contributing You can find the contributing guidelines [here](/CONTRIBUTING.md), Thanks for consider contributing to ReVanced Manager! ## ๐Ÿ”ด Issues For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/new/choose) with ReVanced Manager Compose label. - From e0dfbaf4a31b2e27121c84511776147a8f43f9b9 Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 17:05:53 +0700 Subject: [PATCH 08/55] docs: part 4.2 --- CONTRIBUTING.md | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9dc108643b..e462de0798 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,16 +45,8 @@ # ๐Ÿ‘‹ Contributing guidelines This document describes how to contribute to ReVanced Manager. -## ๐Ÿ’ฌ Community Engagement rules -We pledge to create a nice enviroment to everyone in the ReVanced community, -please follow these rules so we can help reach our goal! - -1. ๐Ÿค— **Be friendly**: If there's a disagreement, don't approach them with aggressive tone! -2. ๐Ÿ’ฌ **Be informative**: If you thinks that the additions or deletion of something is a bad idea, try to be desciptive of why you think this is a bad idea! -3. ๐Ÿ“œ **Follow GitHub Community Guidelines**: These 2 steps above are sufficient enough, but it's recommended that you read the [GitHub's Community Guidelines](https://docs.github.com/en/site-policy/github-terms/github-community-guidelines) - ## ๐Ÿ“– Resources to help you get started -* The [documentation](/docs/README.md) provides the steps by steps tutorial to compile ReVanced Manager from scratch +* 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 @@ -71,7 +63,6 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using [Bug report issue template](https://github.com/ReVanced/revanced-manager/issues/new). ## ๐Ÿ“ How to contribute - > [!NOTE] > It's worth noting that we recommended that you discuss your changes with > the maintainers of ReVanced Manager before contributing. @@ -86,7 +77,7 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using ## ๐Ÿคš I want to contribute but don't know how to code Even if you don't know how to code, you can still help us by -translate the ReVanced Manager application at Crowdin, or spread loves around the community! +translate the ReVanced Manager application at Crowdin! From 9b9525ece5466d3a5f4287b61d84111aeb503496 Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 17:06:43 +0700 Subject: [PATCH 09/55] docs: part 4.3 --- CONTRIBUTING.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e462de0798..59ffc92549 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,7 +42,7 @@ Continuing the legacy of Vanced

-# ๐Ÿ‘‹ Contributing guidelines +# ๐Ÿ‘‹ Contribution guidelines This document describes how to contribute to ReVanced Manager. ## ๐Ÿ“– Resources to help you get started diff --git a/README.md b/README.md index 03b3942a89..0f5a7f2971 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ You can obtain ReVanced Manager by downloading it from either [revanced.app/down Step on how to compile & use the application are available [here](/docs/README.md). ## ๐Ÿ‘‹ Contributing -You can find the contributing guidelines [here](/CONTRIBUTING.md), Thanks for consider contributing to ReVanced Manager! +You can find the contribution guidelines [here](/CONTRIBUTING.md), Thanks for consider contributing to ReVanced Manager! ## ๐Ÿ”ด Issues For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/new/choose) with ReVanced Manager Compose label. From f732df1b9a0217785cbfb29e677d7af39d65f033 Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 17:11:43 +0700 Subject: [PATCH 10/55] docs: part 4.4 --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 59ffc92549..c88d8973d9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,7 +52,7 @@ This document describes how to contribute to ReVanced Manager. ## ๐Ÿ™ 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). +[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 rejected your request at the discretion of maintainers, @@ -60,7 +60,7 @@ Features can be requested by opening an issue using the ## ๐Ÿž 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). +[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] From a503f4830bd4a2e2213f0aec35349131c10b0209 Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 17:15:39 +0700 Subject: [PATCH 11/55] docs: part 4.5 --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c88d8973d9..28061cbbee 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,9 +71,9 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using 1. Fork the repository and create your branch from `dev` 2. Make sure that the commit name are clear and concise as possible and commit your changes. If you have never contributed to this repository before, it's recommended to follow the rules in the [documentation](/docs/README.md) -3. Open a pull request to the `dev` branch and reference issues with `fix: #No.` if needed. +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 PR is approved and merged, it will be included in the next release of ReVanced Manager + 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 help us by From a280fc2446a7964d788f897c1b216c63a07b1a39 Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 17:21:21 +0700 Subject: [PATCH 12/55] docs: part 4.5.1 (test) --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 28061cbbee..3fae64e0d0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,7 @@ srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg" > From cd5787a4f73d7214308ad727481cf2f36bab0572 Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 17:30:32 +0700 Subject: [PATCH 13/55] docs: part 4.6 --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0f5a7f2971..8bb13663e2 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg" > From 2f0cdfff59fa6214f51742b0544eb5fb408330ec Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 17:35:29 +0700 Subject: [PATCH 14/55] docs: part 4.7 --- CONTRIBUTING.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3fae64e0d0..fa82f57bae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -78,8 +78,6 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using ## ๐Ÿคš I want to contribute but don't know how to code Even if you don't know how to code, you can still help us by -translate the ReVanced Manager application at Crowdin! - - +translate the ReVanced Manager application at [Crowdin](https://translate.revanced.app/)! โค๏ธ Thank you for considering contributing to ReVanced Manager From b8378fbb028fcbc963f2f7fbb006292b5dcdf646 Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 17:44:01 +0700 Subject: [PATCH 15/55] docs: part 4.8 --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8bb13663e2..068b19e938 100644 --- a/README.md +++ b/README.md @@ -67,4 +67,14 @@ Step on how to compile & use the application are available [here](/docs/README.m You can find the contribution guidelines [here](/CONTRIBUTING.md), Thanks for consider contributing to ReVanced Manager! ## ๐Ÿ”ด Issues -For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/new/choose) with ReVanced Manager Compose label. +For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=bug&projects=&template=bug-issue.yml&title=bug%3A+%3Ctitle%3E). + +## โš–๏ธ License +> [!IMPORTANT] +> The license is not yet adopted, wait for https://github.com/ReVanced/revanced-manager/issues/1412 +> License might changes!! + +We adopt 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. + +> [!NOTE] +> This is not legal advice From 259f76379ec25546b6b277861fcdca4fa18f7b5c Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 17:50:59 +0700 Subject: [PATCH 16/55] docs: part 4.9 --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 068b19e938..2cb9985a80 100644 --- a/README.md +++ b/README.md @@ -70,11 +70,10 @@ You can find the contribution guidelines [here](/CONTRIBUTING.md), Thanks for co For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=bug&projects=&template=bug-issue.yml&title=bug%3A+%3Ctitle%3E). ## โš–๏ธ License + > [!IMPORTANT] > The license is not yet adopted, wait for https://github.com/ReVanced/revanced-manager/issues/1412 > License might changes!! + -We adopt 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. - -> [!NOTE] -> This is not legal advice +ReVanced Manager adopt 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. From d58fd96bb09d5651a71d7b88f897daebcdca49d4 Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 18:29:51 +0700 Subject: [PATCH 17/55] docs: part 4.10 --- README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 2cb9985a80..84f249d65f 100644 --- a/README.md +++ b/README.md @@ -48,18 +48,21 @@ [![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) ## โ“ About -ReVanced Manager is an Android application that uses ReVanced Patcher to add, remove, and modify existing functionalities in Android applications +ReVanced Manager is an Android application that uses ReVanced Patcher to add, remove, and modify existing functionalities in Android applications. -## ๐Ÿ’ช Features +### ๐Ÿ’ช Features We provide the some of the features are: * ๐Ÿ“ฑ ReVanced Patcher that fit in your pocket! -* ๐Ÿค— Friendly & initutive UI to help you manage your patched applications! -* ๐Ÿ› ๏ธ Lot's of customisation to patch using 3rd-party sources and integration! +* ๐Ÿค— Friendly & intuitive UI to help you manage your patched applications! +* ๐Ÿ› ๏ธ Lots of customization to patch using 3rd-party sources and integration! * โœจ And a lot more! -## ๐Ÿ”ฝ Download +### ๐Ÿ”ฝ 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) +## ๐ŸŒฑ Miscellaneous +Anything else can be found here. + ## ๐Ÿ“„ Documentation Step on how to compile & use the application are available [here](/docs/README.md). @@ -70,10 +73,4 @@ You can find the contribution guidelines [here](/CONTRIBUTING.md), Thanks for co For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=bug&projects=&template=bug-issue.yml&title=bug%3A+%3Ctitle%3E). ## โš–๏ธ License - -> [!IMPORTANT] -> The license is not yet adopted, wait for https://github.com/ReVanced/revanced-manager/issues/1412 -> License might changes!! - - ReVanced Manager adopt 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. From 8a3d16326623821f9c52eea3343a67c5a8cd5c54 Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 19:39:20 +0700 Subject: [PATCH 18/55] docs: part 5 --- CONTRIBUTING.md | 6 ++--- README.md | 6 ++--- docs/3_troubleshooting.md | 6 ----- docs/4_building.md | 38 -------------------------------- docs/README.md | 7 +++--- docs/developers/0_preparation.md | 24 ++++++++++++++++++++ docs/developers/1_overview.md | 38 ++++++++++++++++++++++++++++++++ docs/developers/README.md | 11 +++++++++ 8 files changed, 82 insertions(+), 54 deletions(-) delete mode 100644 docs/4_building.md create mode 100644 docs/developers/0_preparation.md create mode 100644 docs/developers/1_overview.md create mode 100644 docs/developers/README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa82f57bae..763f3edce3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,13 +71,13 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using 1. Fork the repository and create your branch from `dev` 2. Make sure that the commit name are clear and concise as possible and commit your changes. - If you have never contributed to this repository before, it's recommended to follow the rules in the [documentation](/docs/README.md) + If you have never contributed to this repository before, it's recommended to read the overview in the [documentation for developers](/docs/developers/README.md) 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 help us by -translate the ReVanced Manager application at [Crowdin](https://translate.revanced.app/)! +translate the ReVanced Manager application at [Crowdin](https://translate.revanced.app/). -โค๏ธ Thank you for considering contributing to ReVanced Manager +โค๏ธ Thank you for considering contributing to ReVanced Manager. diff --git a/README.md b/README.md index 84f249d65f..b1da83fbe3 100644 --- a/README.md +++ b/README.md @@ -44,8 +44,8 @@

# ๐Ÿ’Š 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 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 "") ## โ“ About ReVanced Manager is an Android application that uses ReVanced Patcher to add, remove, and modify existing functionalities in Android applications. @@ -64,7 +64,7 @@ You can obtain ReVanced Manager by downloading it from either [revanced.app/down Anything else can be found here. ## ๐Ÿ“„ Documentation -Step on how to compile & use the application are available [here](/docs/README.md). +Step on how to use the application are available [here](/docs/README.md). ## ๐Ÿ‘‹ Contributing You can find the contribution guidelines [here](/CONTRIBUTING.md), Thanks for consider contributing to ReVanced Manager! 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..03f5cfe0c0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,9 +1,7 @@ # ๐Ÿ’Š ReVanced Manager - This documentation explains how to use [ReVanced Manager](https://github.com/revanced/revanced-manager). ## ๐Ÿ“– Table of contents - 0. [๐Ÿ’ผ Prerequisites](0_prerequisites.md) 1. [โฌ‡๏ธ Installation](1_installation.md) 2. [๐Ÿ› ๏ธ Usage](2_usage.md) @@ -12,10 +10,11 @@ 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 +## ๐Ÿ‘‹ Developer version +Are you a contributors? Consider checking out developer version of the [documentation](/developers/README.md). +## โญ๏ธ Start here The next page will tell you about the prerequisites for using ReVanced Manager. Continue: [๐Ÿ’ผ Prerequisites](0_prerequisites.md) diff --git a/docs/developers/0_preparation.md b/docs/developers/0_preparation.md new file mode 100644 index 0000000000..dd446a0711 --- /dev/null +++ b/docs/developers/0_preparation.md @@ -0,0 +1,24 @@ +# ๐Ÿ’ผ Preparing a developer environment +In order to compile ReVanced Manager, certain requirements must be met. + +## ๐Ÿ“ Prerequisites +* Kotlin IDE such as [Android Studio](https://developer.android.com/studio) +* Understanding of [Android](https://android.com) OS and [Kotlin](https://kotlinlang.org/) language +* At least Java Development Kit version 17 of any vendors + +## ๐Ÿƒ Prepare the environment +1. Clone the repository + ```sh + git clone https://github.com/ReVanced/revanced-manager.git && cd revanced-manager + ``` + +2. Build the APK + Release variant: + ```sh + ./gradlew assembleRelease -Psign + ``` + +## โญ๏ธ What's next +The next page will introduce you to basic overview of ReVanced Manager + +Continue: [๐Ÿ’ Overview](1_overview.md) diff --git a/docs/developers/1_overview.md b/docs/developers/1_overview.md new file mode 100644 index 0000000000..c0baf11670 --- /dev/null +++ b/docs/developers/1_overview.md @@ -0,0 +1,38 @@ +# ๐Ÿ’ Overview +Take a quick peak of how ReVanced Compose work. + +## โš™๏ธ Technology +We use [Jetpack Compose](https://developer.android.com/jetpack/compose) 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. + +## ๐ŸŒฒ Structure +We structure our code to use MVVM (Model-View-ViewModel) architecture for easier maintenance of the code. + +* **Model**: responsible for retrieving & storing data as well as performing calculations and other operations +* **View**: responsible for displaying the UI to the user, and send inputs to **ViewModel** +* **ViewModel**: responsible for receiving inputs from **View** and send it to **Model** then update the result + +## ๐Ÿง‘โ€๐Ÿ’ป Code readability +In order to maintain readability of the code, It's highly recommend that you follow +https://developer.android.com/jetpack/compose/api-guidelines style guide in order to maintain +consistent readability through out the codebase. + +## ๐ŸŽจ Design language +We adopt the [Material Design 3](https://m3.material.io) as our design language to +bring friendly, intuitive and colourful UI to our application ensuring that the +app's user interface is consistent, customizable, accessible, and engaging for our users. + +## ๐Ÿ“ƒ Commit message +At ReVanced, we follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) +format for our commit message. + +`type`(**optional: scope**): message + +Example: +* `feat`: translation settings +* `fix`(**settings**): NullPointerException when exporting logs +* `refactor`: optimise sub-optimal code +* `perf`(**api**): reduces network latency +* `docs`(**developer**): concise wording +* `build`: bump version to v1.9.3 diff --git a/docs/developers/README.md b/docs/developers/README.md new file mode 100644 index 0000000000..fdcf629f2b --- /dev/null +++ b/docs/developers/README.md @@ -0,0 +1,11 @@ +# ๐Ÿ’Š ReVanced Manager +This documentation explains how the [ReVanced Manager](https://github.com/ReVanced/revanced-manager) work. + +## ๐Ÿ“– Table of contents +0. [๐Ÿ’ผ Preparing a developer environment](0_preparation.md) +1. [๐Ÿ’ Overview](1_overview.md) + +## โญ๏ธ Start here +The next page will tell you how to prepare a environment for ReVanced Manager. + +Continue: [๐Ÿ’ผ Preparing a developer environment](0_preparation.md) From 7bf1a5af65ce0a8f96ab4d9fce459d34d44a623e Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 19:44:05 +0700 Subject: [PATCH 19/55] docs: part 5.1 --- docs/0_prerequisites.md | 3 --- docs/2_1_patching.md | 5 +---- docs/2_2_managing.md | 3 +-- docs/2_3_updating.md | 3 --- docs/2_4_settings.md | 10 ---------- docs/2_usage.md | 3 --- docs/3_troubleshooting.md | 7 ------- 7 files changed, 2 insertions(+), 32 deletions(-) diff --git a/docs/0_prerequisites.md b/docs/0_prerequisites.md index a53b46fb9c..c33d02a17a 100644 --- a/docs/0_prerequisites.md +++ b/docs/0_prerequisites.md @@ -1,16 +1,13 @@ # ๐Ÿ’ผ Prerequisites - In order to use ReVanced Manager, certain requirements must be met. ## ๐Ÿค Requirements - - An Android device running Android 8 or higher - Any device architecture except ARMv7[^1] [^1]: This constraint only applies to patches, that require patching APK resources which is why some patches may or may not work on ARMv7 architecture. You can find out, which architectures your device supports here: [โš™๏ธ Configuring ReVanced Manager](2_4_settings.md#%E2%84%B9%EF%B8%8F-about). ## โญ๏ธ What's next - The next page will guide you through patching an app. Continue: [โฌ‡๏ธ Installation](1_installation.md) diff --git a/docs/2_1_patching.md b/docs/2_1_patching.md index 7203affa2a..e1f1e785d0 100644 --- a/docs/2_1_patching.md +++ b/docs/2_1_patching.md @@ -1,9 +1,7 @@ # ๐Ÿงฉ Patching apps - The following pages will guide you through using ReVanced Manager to patch apps. ## โœ… Steps to patch apps - 1. Navigate to the Apps tab from the top navigation bar 2. Tap the + button in the bottom right corner 3. Choose an app to patch[^1] @@ -11,7 +9,7 @@ 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. @@ -19,7 +17,6 @@ The following pages will guide you through using ReVanced Manager to patch apps. [^3]: Mounting the patched app on top of the original app will only work if the installed app version matches the version of the app selected in step 4. above. ## โญ๏ธ What's next - The next page will bring you back to the usage page. Continue: [๐Ÿ› ๏ธ Usage](2_usage.md) diff --git a/docs/2_2_managing.md b/docs/2_2_managing.md index 29ec56fc4f..e02a3a474e 100644 --- a/docs/2_2_managing.md +++ b/docs/2_2_managing.md @@ -1,11 +1,10 @@ # ๐Ÿงฐ Managing patched apps - After patching an app, you may want to manage it. This page will guide you through managing patched apps. ## โœ… Steps to manage patched apps - 1. Navigate to the Apps tab from the top navigation bar 2. Select the app you want to manage + 3. ## โญ๏ธ What's next diff --git a/docs/2_3_updating.md b/docs/2_3_updating.md index 2b42104cf1..72305eb9bf 100644 --- a/docs/2_3_updating.md +++ b/docs/2_3_updating.md @@ -1,13 +1,10 @@ # ๐Ÿ”„ Updating ReVanced Manager - In order to keep up with the latest features and bug fixes, it is recommended to keep ReVanced Manager up to date. ## โœ… Updating steps - > Currently not implemented ## โญ๏ธ What's next - The next page will bring you back to the usage page. Continue: [๐Ÿ› ๏ธ Usage](2_usage.md) diff --git a/docs/2_4_settings.md b/docs/2_4_settings.md index 008cda463b..8803dedf54 100644 --- a/docs/2_4_settings.md +++ b/docs/2_4_settings.md @@ -1,39 +1,29 @@ # โš™๏ธ Configuring ReVanced Manager - ReVanced Manager has settings that can be configured to your liking. ## โญ Essential settings - - ### ๐Ÿ”— API URL - Specify the URL of the API to use. This is used to fetch ReVanced Patches and update ReVanced Manager. - ### ๐Ÿงฌ Sources - Override the API and change the source of ReVanced Patches. - ### ๐Ÿงช Experimental ReVanced Patches support - Lift app version constraints from ReVanced Patches. This allows you to patch any version of an app, even if the patch is not explicitly compatible with it. - ### ๐Ÿง‘โ€๐Ÿ”ฌ Experimental universal support - This will show or hide ReVanced Patches, which are not meant for any app in particular but rather for all apps but may not work on all apps. - ### ๐Ÿ”‘ Export, import or delete keystore - Manage the keystore used to sign patched apps. - ### ๐Ÿ“„ Export, import or reset ReVanced Patches selection - Manage the ReVanced Patches selection. This is useful if you want to share your ReVanced Patches selection with others or reset it to the default selection. - ### โ„น๏ธ About - View information about your device and ReVanced Manager. This includes the version of ReVanced Manager and supported architectures of your device. ## โญ๏ธ What's next - The next page will bring you back to the usage page. Continue: [๐Ÿ› ๏ธ Usage](2_usage.md) diff --git a/docs/2_usage.md b/docs/2_usage.md index f079782f9c..9267274fc8 100644 --- a/docs/2_usage.md +++ b/docs/2_usage.md @@ -1,16 +1,13 @@ # ๐Ÿ› ๏ธ Usage - The following pages will guide you through using ReVanced Manager to patch apps, manage patched apps, and update ReVanced Manager. ## ๐Ÿ“– Table of contents - 1. [๐Ÿงฉ Patching apps](2_1_patching.md) 2. [๐Ÿงฐ Managing patched apps](2_2_managing.md) 3. [๐Ÿ”„ Updating ReVanced Manager](2_3_updating.md) 4. [โš™๏ธ Configuring ReVanced Manager](2_4_settings.md) ## โญ๏ธ What's next - The next page will guide you through troubleshooting ReVanced Manager. Continue: [โ” Troubleshooting](3_troubleshooting.md) diff --git a/docs/3_troubleshooting.md b/docs/3_troubleshooting.md index 5ac930e81f..c291a5195d 100644 --- a/docs/3_troubleshooting.md +++ b/docs/3_troubleshooting.md @@ -1,25 +1,18 @@ # โ” Troubleshooting - In case you encounter any issues while using ReVanced Manager, please refer to this page for possible solutions. - - ๐Ÿ’‰ Patching fails with an error - Make sure ReVanced Manager is up to date by following [๐Ÿ”„ Updating ReVanced Manager](2_3_updating.md) and select the **Default** button when choosing patches. - ๐Ÿ’ฅ App not installed as package conflicts with an existing package - An existing installation of the app you're trying to patch is conflicting with the patched app. Uninstall the existing app before installing the patched app. - โ—๏ธ Error code `135`, `139` or `1` when patching the app - Your device is not supported. Refer to the [Prerequisites](0_prerequisites.md) page for supported devices. Alternatively, you can use [ReVanced CLI](https://github.com/revanced/revanced-cli) to patch the app. - ๐Ÿšซ Non-root install is not possible with the current patches selection - Select the **Default** button when choosing patches. - ๐Ÿšจ Patched app crashes on launch - Select the **Default** button when choosing patches. From 3c083edfda34295b795a6d46e54daa0c33b9017d Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 19:45:00 +0700 Subject: [PATCH 20/55] docs: part 5.2 --- docs/1_installation.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/1_installation.md b/docs/1_installation.md index d4c08984af..712e0c118c 100644 --- a/docs/1_installation.md +++ b/docs/1_installation.md @@ -1,14 +1,11 @@ # โฌ‡๏ธ Installation - In order to use ReVanced on your Android device, ReVanced Manager must be installed. ## โœ… Installation steps - 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 - The next page will guide you through using ReVanced Manager. Continue: [๐Ÿ› ๏ธ Usage](2_usage.md) From 2f782b4963d32b3a84f2a2668070c806ff889ff6 Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 19:45:49 +0700 Subject: [PATCH 21/55] docs: part 6 --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b1da83fbe3..c399ca3dd2 100644 --- a/README.md +++ b/README.md @@ -63,14 +63,14 @@ You can obtain ReVanced Manager by downloading it from either [revanced.app/down ## ๐ŸŒฑ Miscellaneous Anything else can be found here. -## ๐Ÿ“„ Documentation +### ๐Ÿ“„ Documentation Step on how to use the application are available [here](/docs/README.md). -## ๐Ÿ‘‹ Contributing +### ๐Ÿ‘‹ Contributing You can find the contribution guidelines [here](/CONTRIBUTING.md), Thanks for consider contributing to ReVanced Manager! -## ๐Ÿ”ด Issues +### ๐Ÿ”ด Issues For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=bug&projects=&template=bug-issue.yml&title=bug%3A+%3Ctitle%3E). -## โš–๏ธ License +### โš–๏ธ License ReVanced Manager adopt 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. From 98747f4afb965ff51033d4784540a2cb3b67849b Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 19:54:44 +0700 Subject: [PATCH 22/55] docs: part 6.1 --- CONTRIBUTING.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 763f3edce3..cca63330ca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,7 +14,7 @@     - + diff --git a/README.md b/README.md index c399ca3dd2..65a510f361 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@     - + From 1f5331dbfe3ed01007bdb5b33bb82e61ab1a1871 Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 19:57:00 +0700 Subject: [PATCH 23/55] docs: part 6.2 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 65a510f361..aa6a8ae27a 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ We provide the some of the features are: 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) ## ๐ŸŒฑ Miscellaneous -Anything else can be found here. +Everything else can be found here. ### ๐Ÿ“„ Documentation Step on how to use the application are available [here](/docs/README.md). From 8acdc17cc47956db2c79723626e0a5745c0cee2d Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 19:57:45 +0700 Subject: [PATCH 24/55] docs: part 6.3 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index aa6a8ae27a..37adef83ba 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ Everything else can be found here. Step on how to use the application are available [here](/docs/README.md). ### ๐Ÿ‘‹ Contributing -You can find the contribution guidelines [here](/CONTRIBUTING.md), Thanks for consider contributing to ReVanced Manager! +Thanks for consider contributing to ReVanced Manager, you can find the contribution guidelines [here](/CONTRIBUTING.md). ### ๐Ÿ”ด Issues For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=bug&projects=&template=bug-issue.yml&title=bug%3A+%3Ctitle%3E). From 0d2d87960320546d7893135c62123d21adabd917 Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 20:13:12 +0700 Subject: [PATCH 25/55] docs 6.4 --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 03f5cfe0c0..c7dfe9a538 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,5 @@ # ๐Ÿ’Š 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 0. [๐Ÿ’ผ Prerequisites](0_prerequisites.md) From a70ad3d666350a6f1c8cd4ef471075376aadf39c Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 20:13:42 +0700 Subject: [PATCH 26/55] docs: part 6.5 --- docs/1_installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/1_installation.md b/docs/1_installation.md index 712e0c118c..f353d46b57 100644 --- a/docs/1_installation.md +++ b/docs/1_installation.md @@ -2,7 +2,7 @@ In order to use ReVanced on your Android device, ReVanced Manager must be installed. ## โœ… 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 From 18774084c97ff4b91927b1164e7dfe15067d6aba Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 20:30:53 +0700 Subject: [PATCH 27/55] docs: part 6.6 --- docs/developers/1_overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developers/1_overview.md b/docs/developers/1_overview.md index c0baf11670..fc8a4526e7 100644 --- a/docs/developers/1_overview.md +++ b/docs/developers/1_overview.md @@ -6,7 +6,7 @@ We use [Jetpack Compose](https://developer.android.com/jetpack/compose) 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. -## ๐ŸŒฒ Structure +## ๐Ÿ“‚ Structure We structure our code to use MVVM (Model-View-ViewModel) architecture for easier maintenance of the code. * **Model**: responsible for retrieving & storing data as well as performing calculations and other operations From 7b49af21d02bc38b56f1e039d3e031f9f8a11b53 Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 20:32:34 +0700 Subject: [PATCH 28/55] docs: part 6.7 --- README.md | 2 -- docs/developers/1_overview.md | 2 +- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 37adef83ba..2be2292d31 100644 --- a/README.md +++ b/README.md @@ -61,8 +61,6 @@ We provide the some of the features are: 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) ## ๐ŸŒฑ Miscellaneous -Everything else can be found here. - ### ๐Ÿ“„ Documentation Step on how to use the application are available [here](/docs/README.md). diff --git a/docs/developers/1_overview.md b/docs/developers/1_overview.md index fc8a4526e7..7f9cab3e34 100644 --- a/docs/developers/1_overview.md +++ b/docs/developers/1_overview.md @@ -32,7 +32,7 @@ format for our commit message. Example: * `feat`: translation settings * `fix`(**settings**): NullPointerException when exporting logs -* `refactor`: optimise sub-optimal code +* `refactor`: optimize sub-optimal code * `perf`(**api**): reduces network latency * `docs`(**developer**): concise wording * `build`: bump version to v1.9.3 From cf9a14c762e0ca13ffd22c50b61268b64b581490 Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 20:35:25 +0700 Subject: [PATCH 29/55] docs: part 6.8 --- docs/developers/0_preparation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developers/0_preparation.md b/docs/developers/0_preparation.md index dd446a0711..d353c1d2a6 100644 --- a/docs/developers/0_preparation.md +++ b/docs/developers/0_preparation.md @@ -3,7 +3,7 @@ In order to compile ReVanced Manager, certain requirements must be met. ## ๐Ÿ“ Prerequisites * Kotlin IDE such as [Android Studio](https://developer.android.com/studio) -* Understanding of [Android](https://android.com) OS and [Kotlin](https://kotlinlang.org/) language +* Understanding of [Android](https://android.com) development, [Kotlin](https://kotlinlang.org/) language and [Jetpack Compose](https://developer.android.com/jetpack/compose). * At least Java Development Kit version 17 of any vendors ## ๐Ÿƒ Prepare the environment From d06fb08239a4cbc4a0800545bc01652d0db31a0e Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 20:46:06 +0700 Subject: [PATCH 30/55] docs: part 6.9 --- README.md | 1 - docs/developers/0_preparation.md | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 2be2292d31..a73c991472 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,6 @@ [![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 "") -## โ“ About ReVanced Manager is an Android application that uses ReVanced Patcher to add, remove, and modify existing functionalities in Android applications. ### ๐Ÿ’ช Features diff --git a/docs/developers/0_preparation.md b/docs/developers/0_preparation.md index d353c1d2a6..d56a94ad14 100644 --- a/docs/developers/0_preparation.md +++ b/docs/developers/0_preparation.md @@ -15,7 +15,7 @@ In order to compile ReVanced Manager, certain requirements must be met. 2. Build the APK Release variant: ```sh - ./gradlew assembleRelease -Psign + gradlew assembleRelease -Psign ``` ## โญ๏ธ What's next From f14b697769c42e3b354d0f1b33412ff7e024531f Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 22:43:40 +0700 Subject: [PATCH 31/55] docs: part 7 Co-authored-by: Ushie --- CONTRIBUTING.md | 16 ++++++++-------- README.md | 15 ++++++++------- docs/0_prerequisites.md | 3 +++ docs/1_installation.md | 3 +++ docs/2_1_patching.md | 3 +++ docs/2_2_managing.md | 3 +++ docs/2_3_updating.md | 3 +++ docs/2_4_settings.md | 10 ++++++++++ docs/2_usage.md | 3 +++ docs/3_troubleshooting.md | 6 ++++++ docs/README.md | 5 ++++- docs/developers/0_preparation.md | 8 +++----- docs/developers/1_overview.md | 8 ++++---- docs/developers/README.md | 2 +- 14 files changed, 62 insertions(+), 26 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cca63330ca..0f460900d0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,24 +48,24 @@ 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 +* 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). +[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 rejected your request at the discretion of maintainers, -> please provides good motivation for a request to be accepted. +> 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). +[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] -> It's worth noting that we recommended that you discuss your changes with +> It's worth noting that 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. @@ -77,7 +77,7 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using 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 help us by -translate the ReVanced Manager application at [Crowdin](https://translate.revanced.app/). +Even if you don't know how to code, you can still contribute by +translating the ReVanced Manager application on our [Crowdin](https://translate.revanced.app/). โค๏ธ Thank you for considering contributing to ReVanced Manager. diff --git a/README.md b/README.md index a73c991472..c2d78f69be 100644 --- a/README.md +++ b/README.md @@ -51,15 +51,16 @@ ReVanced Manager is an Android application that uses ReVanced Patcher to add, re ### ๐Ÿ’ช Features We provide the some of the features are: -* ๐Ÿ“ฑ ReVanced Patcher that fit in your pocket! -* ๐Ÿค— Friendly & intuitive UI to help you manage your patched applications! -* ๐Ÿ› ๏ธ Lots of customization to patch using 3rd-party sources and integration! -* โœจ And a lot more! +* ๐Ÿ“ฑ **Portable**: ReVanced Patcher that fit in your pocket! +* ๐Ÿค— **Intuitive UI**: Help you manage your patched applications *intuitively*! +* ๐Ÿ› ๏ธ **Customization**: Patch using 3rd-party sources and integration! +* โœจ 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 obtain ReVanced Manager by downloading it from either [ReVanced site](https://revanced.app/download) or [GitHub Releases](https://github.com/ReVanced/revanced-manager/releases) ## ๐ŸŒฑ Miscellaneous + ### ๐Ÿ“„ Documentation Step on how to use the application are available [here](/docs/README.md). @@ -67,7 +68,7 @@ Step on how to use the application are available [here](/docs/README.md). Thanks for consider contributing to ReVanced Manager, you can find the contribution guidelines [here](/CONTRIBUTING.md). ### ๐Ÿ”ด Issues -For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=bug&projects=&template=bug-issue.yml&title=bug%3A+%3Ctitle%3E). +For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/choose). -### โš–๏ธ License +## โš–๏ธ License ReVanced Manager adopt 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/docs/0_prerequisites.md b/docs/0_prerequisites.md index c33d02a17a..a53b46fb9c 100644 --- a/docs/0_prerequisites.md +++ b/docs/0_prerequisites.md @@ -1,13 +1,16 @@ # ๐Ÿ’ผ Prerequisites + In order to use ReVanced Manager, certain requirements must be met. ## ๐Ÿค Requirements + - An Android device running Android 8 or higher - Any device architecture except ARMv7[^1] [^1]: This constraint only applies to patches, that require patching APK resources which is why some patches may or may not work on ARMv7 architecture. You can find out, which architectures your device supports here: [โš™๏ธ Configuring ReVanced Manager](2_4_settings.md#%E2%84%B9%EF%B8%8F-about). ## โญ๏ธ What's next + The next page will guide you through patching an app. Continue: [โฌ‡๏ธ Installation](1_installation.md) diff --git a/docs/1_installation.md b/docs/1_installation.md index f353d46b57..bcf1a3f5e6 100644 --- a/docs/1_installation.md +++ b/docs/1_installation.md @@ -1,11 +1,14 @@ # โฌ‡๏ธ Installation + In order to use ReVanced on your Android device, ReVanced Manager must be installed. ## โœ… Installation steps + 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 + The next page will guide you through using ReVanced Manager. Continue: [๐Ÿ› ๏ธ Usage](2_usage.md) diff --git a/docs/2_1_patching.md b/docs/2_1_patching.md index e1f1e785d0..9d84bfbd8e 100644 --- a/docs/2_1_patching.md +++ b/docs/2_1_patching.md @@ -1,7 +1,9 @@ # ๐Ÿงฉ Patching apps + The following pages will guide you through using ReVanced Manager to patch apps. ## โœ… Steps to patch apps + 1. Navigate to the Apps tab from the top navigation bar 2. Tap the + button in the bottom right corner 3. Choose an app to patch[^1] @@ -17,6 +19,7 @@ The following pages will guide you through using ReVanced Manager to patch apps. [^3]: Mounting the patched app on top of the original app will only work if the installed app version matches the version of the app selected in step 4. above. ## โญ๏ธ What's next + The next page will bring you back to the usage page. Continue: [๐Ÿ› ๏ธ Usage](2_usage.md) diff --git a/docs/2_2_managing.md b/docs/2_2_managing.md index e02a3a474e..c72a0cd275 100644 --- a/docs/2_2_managing.md +++ b/docs/2_2_managing.md @@ -1,11 +1,14 @@ # ๐Ÿงฐ Managing patched apps + After patching an app, you may want to manage it. This page will guide you through managing patched apps. ## โœ… Steps to manage patched apps + 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/2_3_updating.md b/docs/2_3_updating.md index 72305eb9bf..2b42104cf1 100644 --- a/docs/2_3_updating.md +++ b/docs/2_3_updating.md @@ -1,10 +1,13 @@ # ๐Ÿ”„ Updating ReVanced Manager + In order to keep up with the latest features and bug fixes, it is recommended to keep ReVanced Manager up to date. ## โœ… Updating steps + > Currently not implemented ## โญ๏ธ What's next + The next page will bring you back to the usage page. Continue: [๐Ÿ› ๏ธ Usage](2_usage.md) diff --git a/docs/2_4_settings.md b/docs/2_4_settings.md index 8803dedf54..008cda463b 100644 --- a/docs/2_4_settings.md +++ b/docs/2_4_settings.md @@ -1,29 +1,39 @@ # โš™๏ธ Configuring ReVanced Manager + ReVanced Manager has settings that can be configured to your liking. ## โญ Essential settings + - ### ๐Ÿ”— API URL + Specify the URL of the API to use. This is used to fetch ReVanced Patches and update ReVanced Manager. - ### ๐Ÿงฌ Sources + Override the API and change the source of ReVanced Patches. - ### ๐Ÿงช Experimental ReVanced Patches support + Lift app version constraints from ReVanced Patches. This allows you to patch any version of an app, even if the patch is not explicitly compatible with it. - ### ๐Ÿง‘โ€๐Ÿ”ฌ Experimental universal support + This will show or hide ReVanced Patches, which are not meant for any app in particular but rather for all apps but may not work on all apps. - ### ๐Ÿ”‘ Export, import or delete keystore + Manage the keystore used to sign patched apps. - ### ๐Ÿ“„ Export, import or reset ReVanced Patches selection + Manage the ReVanced Patches selection. This is useful if you want to share your ReVanced Patches selection with others or reset it to the default selection. - ### โ„น๏ธ About + View information about your device and ReVanced Manager. This includes the version of ReVanced Manager and supported architectures of your device. ## โญ๏ธ What's next + The next page will bring you back to the usage page. Continue: [๐Ÿ› ๏ธ Usage](2_usage.md) diff --git a/docs/2_usage.md b/docs/2_usage.md index 9267274fc8..f079782f9c 100644 --- a/docs/2_usage.md +++ b/docs/2_usage.md @@ -1,13 +1,16 @@ # ๐Ÿ› ๏ธ Usage + The following pages will guide you through using ReVanced Manager to patch apps, manage patched apps, and update ReVanced Manager. ## ๐Ÿ“– Table of contents + 1. [๐Ÿงฉ Patching apps](2_1_patching.md) 2. [๐Ÿงฐ Managing patched apps](2_2_managing.md) 3. [๐Ÿ”„ Updating ReVanced Manager](2_3_updating.md) 4. [โš™๏ธ Configuring ReVanced Manager](2_4_settings.md) ## โญ๏ธ What's next + The next page will guide you through troubleshooting ReVanced Manager. Continue: [โ” Troubleshooting](3_troubleshooting.md) diff --git a/docs/3_troubleshooting.md b/docs/3_troubleshooting.md index c291a5195d..c2f9291bc2 100644 --- a/docs/3_troubleshooting.md +++ b/docs/3_troubleshooting.md @@ -1,18 +1,24 @@ # โ” Troubleshooting In case you encounter any issues while using ReVanced Manager, please refer to this page for possible solutions. + - ๐Ÿ’‰ Patching fails with an error + Make sure ReVanced Manager is up to date by following [๐Ÿ”„ Updating ReVanced Manager](2_3_updating.md) and select the **Default** button when choosing patches. - ๐Ÿ’ฅ App not installed as package conflicts with an existing package + An existing installation of the app you're trying to patch is conflicting with the patched app. Uninstall the existing app before installing the patched app. - โ—๏ธ Error code `135`, `139` or `1` when patching the app + Your device is not supported. Refer to the [Prerequisites](0_prerequisites.md) page for supported devices. Alternatively, you can use [ReVanced CLI](https://github.com/revanced/revanced-cli) to patch the app. - ๐Ÿšซ Non-root install is not possible with the current patches selection + Select the **Default** button when choosing patches. - ๐Ÿšจ Patched app crashes on launch + Select the **Default** button when choosing patches. diff --git a/docs/README.md b/docs/README.md index c7dfe9a538..0b327509db 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,9 @@ # ๐Ÿ’Š ReVanced Manager + This documentation explains how to use [ReVanced Manager](https://github.com/ReVanced/revanced-manager). ## ๐Ÿ“– Table of contents + 0. [๐Ÿ’ผ Prerequisites](0_prerequisites.md) 1. [โฌ‡๏ธ Installation](1_installation.md) 2. [๐Ÿ› ๏ธ Usage](2_usage.md) @@ -12,9 +14,10 @@ This documentation explains how to use [ReVanced Manager](https://github.com/ReV 3. [โ” Troubleshooting](3_troubleshooting.md) ## ๐Ÿ‘‹ Developer version -Are you a contributors? Consider checking out developer version of the [documentation](/developers/README.md). +Interested in contributing? Consider checking out developer version of the [documentation](/developers/README.md). ## โญ๏ธ Start here + The next page will tell you about the prerequisites for using ReVanced Manager. Continue: [๐Ÿ’ผ Prerequisites](0_prerequisites.md) diff --git a/docs/developers/0_preparation.md b/docs/developers/0_preparation.md index d56a94ad14..7f041cf407 100644 --- a/docs/developers/0_preparation.md +++ b/docs/developers/0_preparation.md @@ -1,19 +1,17 @@ -# ๐Ÿ’ผ Preparing a developer environment +# ๐Ÿ’ผ Preparing a development environment In order to compile ReVanced Manager, certain requirements must be met. ## ๐Ÿ“ Prerequisites * Kotlin IDE such as [Android Studio](https://developer.android.com/studio) -* Understanding of [Android](https://android.com) development, [Kotlin](https://kotlinlang.org/) language and [Jetpack Compose](https://developer.android.com/jetpack/compose). -* At least Java Development Kit version 17 of any vendors +* Knowledge of [Android](https://android.com) App development, [Kotlin](https://kotlinlang.org/) language. +* At least JDK 17 of any vendors ## ๐Ÿƒ Prepare the environment 1. Clone the repository ```sh git clone https://github.com/ReVanced/revanced-manager.git && cd revanced-manager ``` - 2. Build the APK - Release variant: ```sh gradlew assembleRelease -Psign ``` diff --git a/docs/developers/1_overview.md b/docs/developers/1_overview.md index 7f9cab3e34..8fd163a348 100644 --- a/docs/developers/1_overview.md +++ b/docs/developers/1_overview.md @@ -7,7 +7,7 @@ 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. ## ๐Ÿ“‚ Structure -We structure our code to use MVVM (Model-View-ViewModel) architecture for easier maintenance of the code. +We structure our code to use [MVVM architecture](https://developer.android.com/topic/libraries/architecture/viewmodel) for easier maintenance of the code. * **Model**: responsible for retrieving & storing data as well as performing calculations and other operations * **View**: responsible for displaying the UI to the user, and send inputs to **ViewModel** @@ -15,8 +15,8 @@ We structure our code to use MVVM (Model-View-ViewModel) architecture for easier ## ๐Ÿง‘โ€๐Ÿ’ป Code readability In order to maintain readability of the code, It's highly recommend that you follow -https://developer.android.com/jetpack/compose/api-guidelines style guide in order to maintain -consistent readability through out the codebase. +https://developer.android.com/jetpack/compose/api-guidelines style guide to maintain +consistent style through out the codebase. ## ๐ŸŽจ Design language We adopt the [Material Design 3](https://m3.material.io) as our design language to @@ -34,5 +34,5 @@ Example: * `fix`(**settings**): NullPointerException when exporting logs * `refactor`: optimize sub-optimal code * `perf`(**api**): reduces network latency -* `docs`(**developer**): concise wording +* `docs`(**developer**): correct grammatical mistak * `build`: bump version to v1.9.3 diff --git a/docs/developers/README.md b/docs/developers/README.md index fdcf629f2b..63fe9ef532 100644 --- a/docs/developers/README.md +++ b/docs/developers/README.md @@ -2,7 +2,7 @@ This documentation explains how the [ReVanced Manager](https://github.com/ReVanced/revanced-manager) work. ## ๐Ÿ“– Table of contents -0. [๐Ÿ’ผ Preparing a developer environment](0_preparation.md) +0. [๐Ÿ’ผ Preparing a development environment](0_preparation.md) 1. [๐Ÿ’ Overview](1_overview.md) ## โญ๏ธ Start here From a3c48d14abd89f5463d1e92d01294c9fcf3b9fe7 Mon Sep 17 00:00:00 2001 From: validcube Date: Sat, 21 Oct 2023 22:45:41 +0700 Subject: [PATCH 32/55] docs: part 7.1 --- docs/3_troubleshooting.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/3_troubleshooting.md b/docs/3_troubleshooting.md index c2f9291bc2..5ac930e81f 100644 --- a/docs/3_troubleshooting.md +++ b/docs/3_troubleshooting.md @@ -1,4 +1,5 @@ # โ” Troubleshooting + In case you encounter any issues while using ReVanced Manager, please refer to this page for possible solutions. - ๐Ÿ’‰ Patching fails with an error From 07ee005613b0d290d571007ff5a72a6fff249b1c Mon Sep 17 00:00:00 2001 From: Pun Butrach Date: Sun, 22 Oct 2023 12:38:49 +0700 Subject: [PATCH 33/55] docs: part 8 Co-authored-by: Ushie --- README.md | 8 ++++---- docs/developers/0_preparation.md | 4 ++-- docs/developers/README.md | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c2d78f69be..eebc59983a 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ ReVanced Manager is an Android application that uses ReVanced Patcher to add, re 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 using 3rd-party sources and integration! +* ๐Ÿ› ๏ธ **Customization**: Patch with third-party sources! * โœจ And a **lot more!** ### ๐Ÿ”ฝ Download @@ -62,13 +62,13 @@ You can obtain ReVanced Manager by downloading it from either [ReVanced site](ht ## ๐ŸŒฑ Miscellaneous ### ๐Ÿ“„ Documentation -Step on how to use the application are available [here](/docs/README.md). +Documentation on how to use the application is available [here](/docs/README.md). ### ๐Ÿ‘‹ Contributing -Thanks for consider contributing to ReVanced Manager, you can find the contribution guidelines [here](/CONTRIBUTING.md). +Thank you for considering contributing to ReVanced Manager, you can find the contribution guidelines [here](/CONTRIBUTING.md). ### ๐Ÿ”ด Issues For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/choose). ## โš–๏ธ License -ReVanced Manager adopt 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 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/docs/developers/0_preparation.md b/docs/developers/0_preparation.md index 7f041cf407..84544d5dfc 100644 --- a/docs/developers/0_preparation.md +++ b/docs/developers/0_preparation.md @@ -3,7 +3,7 @@ In order to compile ReVanced Manager, certain requirements must be met. ## ๐Ÿ“ Prerequisites * Kotlin IDE such as [Android Studio](https://developer.android.com/studio) -* Knowledge of [Android](https://android.com) App development, [Kotlin](https://kotlinlang.org/) language. +* Knowledge of [Android](https://android.com) app development, and the [Kotlin](https://kotlinlang.org/) language. * At least JDK 17 of any vendors ## ๐Ÿƒ Prepare the environment @@ -17,6 +17,6 @@ In order to compile ReVanced Manager, certain requirements must be met. ``` ## โญ๏ธ What's next -The next page will introduce you to basic overview of ReVanced Manager +The next page will introduce you to the basic overview of ReVanced Manager Continue: [๐Ÿ’ Overview](1_overview.md) diff --git a/docs/developers/README.md b/docs/developers/README.md index 63fe9ef532..260b3a1d76 100644 --- a/docs/developers/README.md +++ b/docs/developers/README.md @@ -1,11 +1,11 @@ # ๐Ÿ’Š ReVanced Manager -This documentation explains how the [ReVanced Manager](https://github.com/ReVanced/revanced-manager) work. +This documentation explains how [ReVanced Manager](https://github.com/ReVanced/revanced-manager) works. ## ๐Ÿ“– Table of contents 0. [๐Ÿ’ผ Preparing a development environment](0_preparation.md) 1. [๐Ÿ’ Overview](1_overview.md) ## โญ๏ธ Start here -The next page will tell you how to prepare a environment for ReVanced Manager. +The next page will tell you how to prepare a development environment for ReVanced Manager. Continue: [๐Ÿ’ผ Preparing a developer environment](0_preparation.md) From 891fb57531f6bec05e48eeb898a03690168c1f9c Mon Sep 17 00:00:00 2001 From: Pun Butrach Date: Sun, 22 Oct 2023 12:41:45 +0700 Subject: [PATCH 34/55] docs: part 8.1 --- docs/developers/0_preparation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developers/0_preparation.md b/docs/developers/0_preparation.md index 84544d5dfc..ff036652b0 100644 --- a/docs/developers/0_preparation.md +++ b/docs/developers/0_preparation.md @@ -13,7 +13,7 @@ In order to compile ReVanced Manager, certain requirements must be met. ``` 2. Build the APK ```sh - gradlew assembleRelease -Psign + gradlew assembleRelease ``` ## โญ๏ธ What's next From 10815c8f73aa75155e766369077134eff9ed6908 Mon Sep 17 00:00:00 2001 From: Pun Butrach Date: Mon, 23 Oct 2023 00:49:28 +0700 Subject: [PATCH 35/55] docs: part 7.2 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index eebc59983a..64e2c6f243 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ We provide the some of the features are: * โœจ And a **lot more!** ### ๐Ÿ”ฝ Download -You can obtain ReVanced Manager by downloading it from either [ReVanced site](https://revanced.app/download) or [GitHub Releases](https://github.com/ReVanced/revanced-manager/releases) +You can obtain ReVanced Manager by downloading it from either [ReVanced site](https://revanced.app/download) or [GitHub Releases](https://github.com/ReVanced/revanced-manager/releases). ## ๐ŸŒฑ Miscellaneous From a8682d671df61ba60f036169294aca64ad087c4b Mon Sep 17 00:00:00 2001 From: Pun Butrach Date: Mon, 23 Oct 2023 00:49:46 +0700 Subject: [PATCH 36/55] docs: part 8.3 --- docs/developers/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developers/README.md b/docs/developers/README.md index 260b3a1d76..1e85a5b24f 100644 --- a/docs/developers/README.md +++ b/docs/developers/README.md @@ -8,4 +8,4 @@ This documentation explains how [ReVanced Manager](https://github.com/ReVanced/r ## โญ๏ธ Start here The next page will tell you how to prepare a development environment for ReVanced Manager. -Continue: [๐Ÿ’ผ Preparing a developer environment](0_preparation.md) +Continue: [๐Ÿ’ผ Preparing a development environment](0_preparation.md) From af49457bfc16846da8e037e411036f0bd93a4a1a Mon Sep 17 00:00:00 2001 From: Pun Butrach Date: Mon, 23 Oct 2023 00:50:38 +0700 Subject: [PATCH 37/55] docs: part 8.4-1 --- docs/developers/1_overview.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/developers/1_overview.md b/docs/developers/1_overview.md index 8fd163a348..656104929f 100644 --- a/docs/developers/1_overview.md +++ b/docs/developers/1_overview.md @@ -9,9 +9,6 @@ It provides a unified and efficient way of building UI that is well-integrated w ## ๐Ÿ“‚ Structure We structure our code to use [MVVM architecture](https://developer.android.com/topic/libraries/architecture/viewmodel) for easier maintenance of the code. -* **Model**: responsible for retrieving & storing data as well as performing calculations and other operations -* **View**: responsible for displaying the UI to the user, and send inputs to **ViewModel** -* **ViewModel**: responsible for receiving inputs from **View** and send it to **Model** then update the result ## ๐Ÿง‘โ€๐Ÿ’ป Code readability In order to maintain readability of the code, It's highly recommend that you follow From 94eb893a0126a787f81c648679957171741fea4a Mon Sep 17 00:00:00 2001 From: Pun Butrach Date: Mon, 23 Oct 2023 00:51:58 +0700 Subject: [PATCH 38/55] docs: 8.4-1.1 --- docs/developers/1_overview.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/developers/1_overview.md b/docs/developers/1_overview.md index 656104929f..019873ae46 100644 --- a/docs/developers/1_overview.md +++ b/docs/developers/1_overview.md @@ -9,7 +9,6 @@ It provides a unified and efficient way of building UI that is well-integrated w ## ๐Ÿ“‚ Structure We structure our code to use [MVVM architecture](https://developer.android.com/topic/libraries/architecture/viewmodel) for easier maintenance of the code. - ## ๐Ÿง‘โ€๐Ÿ’ป Code readability In order to maintain readability of the code, It's highly recommend that you follow https://developer.android.com/jetpack/compose/api-guidelines style guide to maintain From dcf51c1777fe71e6021603b702df31bdb6ecae9e Mon Sep 17 00:00:00 2001 From: Pun Butrach Date: Mon, 23 Oct 2023 00:52:19 +0700 Subject: [PATCH 39/55] docs: part 8.4-2 --- docs/developers/1_overview.md | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/docs/developers/1_overview.md b/docs/developers/1_overview.md index 019873ae46..bb1f43801e 100644 --- a/docs/developers/1_overview.md +++ b/docs/developers/1_overview.md @@ -22,13 +22,3 @@ app's user interface is consistent, customizable, accessible, and engaging for o ## ๐Ÿ“ƒ Commit message At ReVanced, we follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) format for our commit message. - -`type`(**optional: scope**): message - -Example: -* `feat`: translation settings -* `fix`(**settings**): NullPointerException when exporting logs -* `refactor`: optimize sub-optimal code -* `perf`(**api**): reduces network latency -* `docs`(**developer**): correct grammatical mistak -* `build`: bump version to v1.9.3 From 2f31fc7d6e568e705b13d104abc475c9400dc58c Mon Sep 17 00:00:00 2001 From: validcube Date: Mon, 23 Oct 2023 15:07:17 +0700 Subject: [PATCH 40/55] docs: part 8.5 TODO: see PR #1411 suggestions Co-authored-by: Palm Co-authored-by: oSumAtrIX --- CONTRIBUTING.md | 6 +++--- README.md | 2 ++ docs/2_1_patching.md | 3 ++- docs/README.md | 2 +- docs/developers/0_preparation.md | 2 +- 5 files changed, 9 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f460900d0..2105c00ef5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,11 +65,11 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using ## ๐Ÿ“ How to contribute > [!NOTE] -> It's worth noting that we recommend that you discuss your changes with +> 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` +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. If you have never contributed to this repository before, it's recommended to read the overview in the [documentation for developers](/docs/developers/README.md) 3. Open a pull request to the `dev` branch and reference issues that your pull request closes @@ -78,6 +78,6 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using ## ๐Ÿคš 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 the ReVanced Manager application on our [Crowdin](https://translate.revanced.app/). +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 64e2c6f243..06026f4927 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,7 @@

# ๐Ÿ’Š 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 "") @@ -51,6 +52,7 @@ ReVanced Manager is an Android application that uses ReVanced Patcher to add, re ### ๐Ÿ’ช 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! diff --git a/docs/2_1_patching.md b/docs/2_1_patching.md index 9d84bfbd8e..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/README.md b/docs/README.md index 0b327509db..523af847f8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,7 +14,7 @@ This documentation explains how to use [ReVanced Manager](https://github.com/ReV 3. [โ” Troubleshooting](3_troubleshooting.md) ## ๐Ÿ‘‹ Developer version -Interested in contributing? Consider checking out developer version of the [documentation](/developers/README.md). +Interested in contributing? Consider checking out the developer [documentation](/developers/README.md) ## โญ๏ธ Start here diff --git a/docs/developers/0_preparation.md b/docs/developers/0_preparation.md index ff036652b0..154d2af82f 100644 --- a/docs/developers/0_preparation.md +++ b/docs/developers/0_preparation.md @@ -11,7 +11,7 @@ In order to compile ReVanced Manager, certain requirements must be met. ```sh git clone https://github.com/ReVanced/revanced-manager.git && cd revanced-manager ``` -2. Build the APK +2. Build the application ```sh gradlew assembleRelease ``` From 0419b2f86b8062dd0012b14be56f97e23be724ff Mon Sep 17 00:00:00 2001 From: validcube Date: Mon, 23 Oct 2023 15:16:34 +0700 Subject: [PATCH 41/55] docs: part 8.6 --- CONTRIBUTING.md | 6 ++++++ README.md | 6 ++++++ docs/README.md | 1 + docs/developers/0_preparation.md | 4 ++++ docs/developers/1_overview.md | 6 ++++++ docs/developers/README.md | 3 +++ 6 files changed, 26 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2105c00ef5..33800674b7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,14 +44,17 @@

# ๐Ÿ‘‹ 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). @@ -60,10 +63,12 @@ Features can be requested by opening an issue using the > 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. @@ -77,6 +82,7 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using 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/). diff --git a/README.md b/README.md index 06026f4927..c949747929 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,7 @@ 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! @@ -59,18 +60,23 @@ We provide the some of the features are: * โœจ And a **lot more!** ### ๐Ÿ”ฝ Download + You can obtain ReVanced Manager by downloading it from either [ReVanced site](https://revanced.app/download) or [GitHub Releases](https://github.com/ReVanced/revanced-manager/releases). ## ๐ŸŒฑ Miscellaneous ### ๐Ÿ“„ Documentation + Documentation on how to use the application is available [here](/docs/README.md). ### ๐Ÿ‘‹ Contributing + Thank you for considering contributing to ReVanced Manager, you can find the contribution guidelines [here](/CONTRIBUTING.md). ### ๐Ÿ”ด Issues + For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/choose). ## โš–๏ธ 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. diff --git a/docs/README.md b/docs/README.md index 523af847f8..ef892fb12c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,6 +14,7 @@ This documentation explains how to use [ReVanced Manager](https://github.com/ReV 3. [โ” Troubleshooting](3_troubleshooting.md) ## ๐Ÿ‘‹ Developer version + Interested in contributing? Consider checking out the developer [documentation](/developers/README.md) ## โญ๏ธ Start here diff --git a/docs/developers/0_preparation.md b/docs/developers/0_preparation.md index 154d2af82f..f3c5a8effc 100644 --- a/docs/developers/0_preparation.md +++ b/docs/developers/0_preparation.md @@ -1,12 +1,15 @@ # ๐Ÿ’ผ Preparing a development environment + In order to compile ReVanced Manager, certain requirements must be met. ## ๐Ÿ“ Prerequisites + * Kotlin IDE such as [Android Studio](https://developer.android.com/studio) * Knowledge of [Android](https://android.com) app development, and the [Kotlin](https://kotlinlang.org/) language. * At least JDK 17 of any vendors ## ๐Ÿƒ Prepare the environment + 1. Clone the repository ```sh git clone https://github.com/ReVanced/revanced-manager.git && cd revanced-manager @@ -17,6 +20,7 @@ In order to compile ReVanced Manager, certain requirements must be met. ``` ## โญ๏ธ What's next + The next page will introduce you to the basic overview of ReVanced Manager Continue: [๐Ÿ’ Overview](1_overview.md) diff --git a/docs/developers/1_overview.md b/docs/developers/1_overview.md index bb1f43801e..fa2a0b9c9f 100644 --- a/docs/developers/1_overview.md +++ b/docs/developers/1_overview.md @@ -1,24 +1,30 @@ # ๐Ÿ’ Overview + Take a quick peak of how ReVanced Compose work. ## โš™๏ธ Technology + We use [Jetpack Compose](https://developer.android.com/jetpack/compose) 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. ## ๐Ÿ“‚ Structure + We structure our code to use [MVVM architecture](https://developer.android.com/topic/libraries/architecture/viewmodel) for easier maintenance of the code. ## ๐Ÿง‘โ€๐Ÿ’ป Code readability + In order to maintain readability of the code, It's highly recommend that you follow https://developer.android.com/jetpack/compose/api-guidelines style guide to maintain consistent style through out the codebase. ## ๐ŸŽจ Design language + We adopt the [Material Design 3](https://m3.material.io) as our design language to bring friendly, intuitive and colourful UI to our application ensuring that the app's user interface is consistent, customizable, accessible, and engaging for our users. ## ๐Ÿ“ƒ Commit message + At ReVanced, we follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) format for our commit message. diff --git a/docs/developers/README.md b/docs/developers/README.md index 1e85a5b24f..6cbc0dc6cd 100644 --- a/docs/developers/README.md +++ b/docs/developers/README.md @@ -1,11 +1,14 @@ # ๐Ÿ’Š ReVanced Manager + This documentation explains how [ReVanced Manager](https://github.com/ReVanced/revanced-manager) works. ## ๐Ÿ“– Table of contents + 0. [๐Ÿ’ผ Preparing a development environment](0_preparation.md) 1. [๐Ÿ’ Overview](1_overview.md) ## โญ๏ธ Start here + The next page will tell you how to prepare a development environment for ReVanced Manager. Continue: [๐Ÿ’ผ Preparing a development environment](0_preparation.md) From bc09af9d0bd71423d2e9a9a3047e47eef7b6ba51 Mon Sep 17 00:00:00 2001 From: Pun Butrach Date: Mon, 23 Oct 2023 15:28:56 +0700 Subject: [PATCH 42/55] docs: part 8.6.1 (test) --- README.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c949747929..dba3e5a59b 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,10 @@
- + + + +     @@ -21,13 +24,22 @@     - + + + +     - + + + +     - + + + +     @@ -36,7 +48,10 @@     - + + + +

From 944b57c336cebdc6ecd29bbde7a8b52d958986c9 Mon Sep 17 00:00:00 2001 From: validcube Date: Wed, 8 Nov 2023 22:19:54 +0700 Subject: [PATCH 43/55] docs: part 8.7 Co-authored-by: KobeW50 <84587632+KobeW50@users.noreply.github.com> --- docs/README.md | 2 +- docs/developers/1_overview.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index ef892fb12c..b3f2a277e5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -15,7 +15,7 @@ This documentation explains how to use [ReVanced Manager](https://github.com/ReV ## ๐Ÿ‘‹ Developer version -Interested in contributing? Consider checking out the developer [documentation](/developers/README.md) +Interested in contributing? Consider checking out the developer version of [documentation](/developers/README.md) ## โญ๏ธ Start here diff --git a/docs/developers/1_overview.md b/docs/developers/1_overview.md index fa2a0b9c9f..5ac0b60c7a 100644 --- a/docs/developers/1_overview.md +++ b/docs/developers/1_overview.md @@ -1,6 +1,6 @@ # ๐Ÿ’ Overview -Take a quick peak of how ReVanced Compose work. +Take a quick peak of how ReVanced Compose works. ## โš™๏ธ Technology From 2a3395ce1503305da235ca595d3d1b7ee480c1a7 Mon Sep 17 00:00:00 2001 From: validcube Date: Wed, 8 Nov 2023 22:25:33 +0700 Subject: [PATCH 44/55] docs: part 9 This commit removes the developer version, preventing this PR from being locked up with additional developer experiences. --- CONTRIBUTING.md | 1 - docs/README.md | 4 ---- docs/developers/0_preparation.md | 26 -------------------------- docs/developers/1_overview.md | 30 ------------------------------ docs/developers/README.md | 14 -------------- 5 files changed, 75 deletions(-) delete mode 100644 docs/developers/0_preparation.md delete mode 100644 docs/developers/1_overview.md delete mode 100644 docs/developers/README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 33800674b7..2af7a944ba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -76,7 +76,6 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using 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. - If you have never contributed to this repository before, it's recommended to read the overview in the [documentation for developers](/docs/developers/README.md) 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 diff --git a/docs/README.md b/docs/README.md index b3f2a277e5..f6ae368a56 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,10 +13,6 @@ This documentation explains how to use [ReVanced Manager](https://github.com/ReV 4. [โš™๏ธ Configuring ReVanced Manager](2_4_settings.md) 3. [โ” Troubleshooting](3_troubleshooting.md) -## ๐Ÿ‘‹ Developer version - -Interested in contributing? Consider checking out the developer version of [documentation](/developers/README.md) - ## โญ๏ธ Start here The next page will tell you about the prerequisites for using ReVanced Manager. diff --git a/docs/developers/0_preparation.md b/docs/developers/0_preparation.md deleted file mode 100644 index f3c5a8effc..0000000000 --- a/docs/developers/0_preparation.md +++ /dev/null @@ -1,26 +0,0 @@ -# ๐Ÿ’ผ Preparing a development environment - -In order to compile ReVanced Manager, certain requirements must be met. - -## ๐Ÿ“ Prerequisites - -* Kotlin IDE such as [Android Studio](https://developer.android.com/studio) -* Knowledge of [Android](https://android.com) app development, and the [Kotlin](https://kotlinlang.org/) language. -* At least JDK 17 of any vendors - -## ๐Ÿƒ Prepare the environment - -1. Clone the repository - ```sh - git clone https://github.com/ReVanced/revanced-manager.git && cd revanced-manager - ``` -2. Build the application - ```sh - gradlew assembleRelease - ``` - -## โญ๏ธ What's next - -The next page will introduce you to the basic overview of ReVanced Manager - -Continue: [๐Ÿ’ Overview](1_overview.md) diff --git a/docs/developers/1_overview.md b/docs/developers/1_overview.md deleted file mode 100644 index 5ac0b60c7a..0000000000 --- a/docs/developers/1_overview.md +++ /dev/null @@ -1,30 +0,0 @@ -# ๐Ÿ’ Overview - -Take a quick peak of how ReVanced Compose works. - -## โš™๏ธ Technology - -We use [Jetpack Compose](https://developer.android.com/jetpack/compose) 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. - -## ๐Ÿ“‚ Structure - -We structure our code to use [MVVM architecture](https://developer.android.com/topic/libraries/architecture/viewmodel) for easier maintenance of the code. - -## ๐Ÿง‘โ€๐Ÿ’ป Code readability - -In order to maintain readability of the code, It's highly recommend that you follow -https://developer.android.com/jetpack/compose/api-guidelines style guide to maintain -consistent style through out the codebase. - -## ๐ŸŽจ Design language - -We adopt the [Material Design 3](https://m3.material.io) as our design language to -bring friendly, intuitive and colourful UI to our application ensuring that the -app's user interface is consistent, customizable, accessible, and engaging for our users. - -## ๐Ÿ“ƒ Commit message - -At ReVanced, we follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) -format for our commit message. diff --git a/docs/developers/README.md b/docs/developers/README.md deleted file mode 100644 index 6cbc0dc6cd..0000000000 --- a/docs/developers/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# ๐Ÿ’Š ReVanced Manager - -This documentation explains how [ReVanced Manager](https://github.com/ReVanced/revanced-manager) works. - -## ๐Ÿ“– Table of contents - -0. [๐Ÿ’ผ Preparing a development environment](0_preparation.md) -1. [๐Ÿ’ Overview](1_overview.md) - -## โญ๏ธ Start here - -The next page will tell you how to prepare a development environment for ReVanced Manager. - -Continue: [๐Ÿ’ผ Preparing a development environment](0_preparation.md) From d32a213457639e14a97a40ef567aff3703d08c7f Mon Sep 17 00:00:00 2001 From: validcube Date: Wed, 8 Nov 2023 22:31:19 +0700 Subject: [PATCH 45/55] docs: part 9.1 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dba3e5a59b..6f5310452f 100644 --- a/README.md +++ b/README.md @@ -69,9 +69,9 @@ ReVanced Manager is an Android application that uses ReVanced Patcher to add, re 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! +* ๐Ÿ“ฑ **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 From 35996b6c69c233877c2749c34c8d3116f88a01a1 Mon Sep 17 00:00:00 2001 From: Pun Butrach Date: Wed, 8 Nov 2023 22:41:12 +0700 Subject: [PATCH 46/55] docs: part 9.2 Co-authored-by: Palm --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6f5310452f..37c790f94d 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ We provide the some of the features are: ### ๐Ÿ”ฝ Download -You can obtain ReVanced Manager by downloading it from either [ReVanced site](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). ## ๐ŸŒฑ Miscellaneous From 1521d21e4e91dfed39316f974544e385aabac055 Mon Sep 17 00:00:00 2001 From: Pun Butrach Date: Wed, 8 Nov 2023 23:46:31 +0700 Subject: [PATCH 47/55] docs: part 9.3 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 37c790f94d..4aaeb65db5 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ We provide the some of the features are: You can get ReVanced Manager by downloading from [ReVanced site](https://revanced.app/download) or [GitHub releases](https://github.com/ReVanced/revanced-manager/releases). -## ๐ŸŒฑ Miscellaneous +## ๐Ÿ“š Everything else ### ๐Ÿ“„ Documentation From 62bb0d34cea385944ccdeed16310bbb47dc4272d Mon Sep 17 00:00:00 2001 From: Pun Butrach Date: Thu, 9 Nov 2023 00:01:02 +0700 Subject: [PATCH 48/55] docs(accessibility): part 9.4 Heading 1 -> 2 -> 3 not 1 -> 3 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4aaeb65db5..772c7ca202 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ ReVanced Manager is an Android application that uses ReVanced Patcher to add, remove, and modify existing functionalities in Android applications. -### ๐Ÿ’ช Features +## ๐Ÿ’ช Features We provide the some of the features are: @@ -74,7 +74,7 @@ We provide the some of the features are: * ๐Ÿ› ๏ธ **Customization**: Patch with third-party sources; * โœจ And a **lot more!** -### ๐Ÿ”ฝ Download +## ๐Ÿ”ฝ 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). From 94de17049068de6cce725556a8cc5bd622e99ca8 Mon Sep 17 00:00:00 2001 From: Pun Butrach Date: Sat, 9 Dec 2023 21:40:43 +0700 Subject: [PATCH 49/55] docs: part 9.5 merge changes from `dev` (flutter) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 772c7ca202..d99ca437aa 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ ReVanced Manager is an Android application that uses ReVanced Patcher to add, re 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*; +* ๐Ÿค— **Intuitive UI**: Help you manage your patched applications with easy-to-use interface; * ๐Ÿ› ๏ธ **Customization**: Patch with third-party sources; * โœจ And a **lot more!** From adf5f9f6e86be9a3f3b4c68bb757fa8b3ef85891 Mon Sep 17 00:00:00 2001 From: validcube Date: Sun, 18 Aug 2024 20:00:17 +0700 Subject: [PATCH 50/55] docs: Pull change from ReVanced Branding --- .../revanced-logo/{revanced-logo-round.svg => revanced-logo.svg} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename assets/revanced-logo/{revanced-logo-round.svg => revanced-logo.svg} (100%) 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 From a290369d8d39a1bf0e58580bed31d528f79f998b Mon Sep 17 00:00:00 2001 From: validcube Date: Sun, 18 Aug 2024 20:00:44 +0700 Subject: [PATCH 51/55] docs: Pull change from ReVanced Manager Flutter --- SECURITY.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) 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: | From db4ce6bb77f213fc29281773cab9d7da1dba1c4b Mon Sep 17 00:00:00 2001 From: validcube Date: Sun, 18 Aug 2024 20:01:45 +0700 Subject: [PATCH 52/55] docs: Use correct asset directory --- CONTRIBUTING.md | 25 ++++++++++++++++++++----- README.md | 4 ++-- 2 files changed, 22 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2af7a944ba..d4cc28bf92 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,10 @@
- + + + +     @@ -21,13 +24,22 @@     - + + + +     - + + + +     - + + + +     @@ -36,7 +48,10 @@     - + + + +

diff --git a/README.md b/README.md index d99ca437aa..6f904cde86 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,8 @@
- - + +     From 3bbad156c465ad292f31457c24e78af1c31d08db Mon Sep 17 00:00:00 2001 From: validcube Date: Sun, 18 Aug 2024 20:41:45 +0700 Subject: [PATCH 53/55] part: 10 (1/?) --- CONTRIBUTING.md | 25 +++++++++++++----------- README.md | 42 +++++++++++++++++++++++++---------------- docs/0_prerequisites.md | 13 +++++++++++-- docs/1_installation.md | 7 +++++-- 4 files changed, 56 insertions(+), 31 deletions(-) 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 From 05bf940cdf51dc9fd93c971efb169baf76de96ef Mon Sep 17 00:00:00 2001 From: validcube Date: Sun, 18 Aug 2024 20:43:29 +0700 Subject: [PATCH 54/55] nitpicking on style --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f371a7002c..413c4ca735 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -100,7 +100,7 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using 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 [OpenCollective](https://opencollective.com/ReVanced). +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 From 911201ad9f9bf2f78d380e5cfe3e2940fed84e5a Mon Sep 17 00:00:00 2001 From: validcube Date: Fri, 18 Oct 2024 01:53:51 +0700 Subject: [PATCH 55/55] Signed off to switch branch Signed-off-by: validcube --- docs/0_prerequisites.md | 7 +++---- docs/1_installation.md | 2 +- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/0_prerequisites.md b/docs/0_prerequisites.md index 773e11d373..eab3b19b95 100644 --- a/docs/0_prerequisites.md +++ b/docs/0_prerequisites.md @@ -5,15 +5,14 @@ To use ReVanced Manager, an certain requirements had to be met. ## ๐Ÿค Requirements - Android device running Android 8.0 or higher -- System that support running at least arm64-v8a, armeabi-v7a, x86_64, or x86 application +- 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. +> These requirement(s) are not required to be met. -- Rooted Android device with [KernelSU](https://github.com/tiann/KernelSU) v1.0.1 or [Magisk](https://github.com/topjohnwu/Magisk) v25.2 or higher +- 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 0a95577e77..67e3518cda 100644 --- a/docs/1_installation.md +++ b/docs/1_installation.md @@ -3,7 +3,7 @@ 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. Get the latest version of ReVanced Manager from the [ReVanced site](https://revanced.app/download)