diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa82f57b..763f3edc 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 84f249d6..b1da83fb 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 5a860c6b..5ac930e8 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 56917e5f..00000000 --- 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 af2926b6..03f5cfe0 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) + +## 👋 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 00000000..dd446a07 --- /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 00000000..c0baf116 --- /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 00000000..fdcf629f --- /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)