ReVanced/revanced-manager
1
0
Fork 0
mirror of https://github.com/revanced/revanced-manager.git synced 2025-05-04 15:54:25 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: part 9

Browse Source 
This commit removes the developer version, preventing this PR from being locked up with additional developer experiences.
This commit is contained in:
validcube 2023-11-08 22:25:33 +07:00
parent 944b57c336
commit 2a3395ce15
No known key found for this signature in database
GPG Key ID: DBA94253E1D3F267
5 changed files with 0 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CONTRIBUTING.md
View File

@ -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 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. 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 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. 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 Once your pull request is approved and merged, it will be included in the next release of ReVanced Manager

4
docs/README.md
View File

@ -13,10 +13,6 @@ This documentation explains how to use [ReVanced Manager](https://github.com/ReV
4. [⚙️ Configuring ReVanced Manager](2_4_settings.md) 4. [⚙️ Configuring ReVanced Manager](2_4_settings.md)
3. [❔ Troubleshooting](3_troubleshooting.md) 3. [❔ Troubleshooting](3_troubleshooting.md)
## 👋 Developer version
Interested in contributing? Consider checking out the developer version of [documentation](/developers/README.md)
## ⏭️ Start here ## ⏭️ Start here
The next page will tell you about the prerequisites for using ReVanced Manager. The next page will tell you about the prerequisites for using ReVanced Manager.

26
docs/developers/0_preparation.md
View File

@ -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)

30
docs/developers/1_overview.md
View File

@ -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.

14
docs/developers/README.md
View File

@ -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)