-
-
Notifications
You must be signed in to change notification settings - Fork 766
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
82 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
| ``` | ||
| <!-- This assume that you can use Maven repository --> | ||
| 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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |