mirror of
https://github.com/revanced/revanced-manager.git
synced 2025-05-11 18:34:25 +02:00
docs: part 5
This commit is contained in:
validcube
parent
d58fd96bb0
commit
8a3d163266
@ -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.
|
||||
|
||||
@ -44,8 +44,8 @@
|
||||
</p>
|
||||
|
||||
# 💊 ReVanced Manager
|
||||
[](https://github.com/ReVanced/revanced-manager/commits/compose-dev)
|
||||
[](https://github.com/ReVanced/revanced-manager-compose/commits/compose-dev)
|
||||
[](https://github.com/ReVanced/revanced-manager/commits/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!
|
||||
|
||||
@ -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)
|
||||
|
||||
@ -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
|
||||
```
|
||||
@ -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)
|
||||
|
||||
24
docs/developers/0_preparation.md
Normal file
24
docs/developers/0_preparation.md
Normal file
@ -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)
|
||||
38
docs/developers/1_overview.md
Normal file
38
docs/developers/1_overview.md
Normal file
@ -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
|
||||
11
docs/developers/README.md
Normal file
11
docs/developers/README.md
Normal file
@ -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)
|
||||
Loading…
x
Reference in New Issue
Block a user