Skip to content

Commit 3bbad15

Browse files
committed
part: 10 (1/?)
1 parent db4ce6b commit 3bbad15

File tree

4 files changed

+56
-31
lines changed

4 files changed

+56
-31
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,8 @@
6060

6161
# 👋 Contribution guidelines
6262

63-
This document describes how to contribute to ReVanced Manager.
63+
Welcome to contribution guidelines, this document contains
64+
everything you'll need to contribute to ReVanced Manager.
6465

6566
## 📖 Resources to help you get started
6667

@@ -74,8 +75,8 @@ Features can be requested by opening an issue using the
7475
[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).
7576

7677
> [!NOTE]
77-
> We may reject your request at the discretion of ReVanced Manager's maintainers,
78-
> please provide good motivation for a request to be accepted.
78+
> Requests can be accepted or rejected at the discretion of maintainers of ReVanced Manager.
79+
> Good motivation has to be provided for a request to be accepted.
7980
8081
## 🐞 Submitting a bug report
8182

@@ -84,20 +85,22 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using
8485

8586
## 📝 How to contribute
8687

87-
> [!NOTE]
88+
> [!TIP]
8889
> We recommend that you discuss your changes with
8990
> the maintainers of ReVanced Manager before contributing.
9091
> This will help you determine whether your change is acceptable.
9192
92-
1. Fork the repository and create a new branch based off the `dev` branch
93-
2. Make sure that the commit name are clear and concise as possible and commit your changes.
94-
3. Open a pull request to the `dev` branch and reference issues that your pull request closes
95-
4. The maintainers of ReVanced Manager will review and provide suggestions.
96-
Once your pull request is approved and merged, it will be included in the next release of ReVanced Manager
93+
1. Fork the repository and create your branch from `dev`
94+
2. Commit your changes
95+
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
96+
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
97+
the next release of ReVanced Manager
9798

9899
## 🤚 I want to contribute but don't know how to code
99100

100101
Even if you don't know how to code, you can still contribute by
101-
translating ReVanced Manager on [Crowdin](https://translate.revanced.app/).
102+
translating ReVanced Manager on [Crowdin](https://translate.revanced.app/)
103+
or sponsor us at [GitHub Sponsor](https://github.com/sponsors/ReVanced) and [OpenCollective](https://opencollective.com/ReVanced).
102104

103-
❤️ Thank you for considering contributing to ReVanced Manager.
105+
❤️ Thank you for considering contributing to ReVanced Manager,
106+
ReVanced

README.md

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -60,38 +60,48 @@
6060

6161
# 💊 ReVanced Manager
6262

63-
[![GitHub last commit](https://img.shields.io/github/last-commit/ReVanced/revanced-manager/compose-dev)](https://github.com/ReVanced/revanced-manager/commits/compose-dev "")
64-
[![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 "")
63+
[![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)
64+
[![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)](#️-license)
6565

66-
ReVanced Manager is an Android application that uses ReVanced Patcher to add, remove, and modify existing functionalities in Android applications.
66+
Application to use ReVanced on Android
67+
68+
## ❓ About
69+
70+
ReVanced Manager is an application that uses [ReVanced Patcher](https://github.com/revanced/revanced-patcher) to patch Android apps.
6771

6872
## 💪 Features
6973

70-
We provide the some of the features are:
74+
Some of the features ReVanced Manager provides are:
7175

72-
* 📱 **Portable**: ReVanced Patcher that fit in your pocket;
73-
* 🤗 **Intuitive UI**: Help you manage your patched applications with easy-to-use interface;
74-
* 🛠️ **Customization**: Patch with third-party sources;
75-
* ✨ And a **lot more!**
76+
- 💉 **Patch apps**: Apply any patch of your choice to Android apps
77+
- 📱 **Portable**: ReVanced Patcher that fits in your pocket
78+
- 🤗 **Simple UI**: Quickly understand the ins and outs of ReVanced Manager
79+
- 🛠️ **Customization**: Configurable API, custom sources, language, signing keystore, theme and more
7680

7781
## 🔽 Download
7882

79-
You can get ReVanced Manager by downloading from [ReVanced site](https://revanced.app/download) or [GitHub releases](https://github.com/ReVanced/revanced-manager/releases).
83+
You can get ReVanced Manager the most recent version of by downloading from
84+
the [ReVanced site](https://revanced.app/download) or [GitHub releases](https://github.com/ReVanced/revanced-manager/releases/latest).
85+
86+
Learn how to use ReVanced Manager by following the [documentation](/docs).
8087

8188
## 📚 Everything else
8289

83-
### 📄 Documentation
90+
### 📙 Contributing
8491

85-
Documentation on how to use the application is available [here](/docs/README.md).
92+
You can find the contribution guidelines [here](CONTRIBUTING.md).
93+
Thank you for considering contributing to ReVanced Manager.
8694

87-
### 👋 Contributing
95+
### 🛠️ Building
8896

89-
Thank you for considering contributing to ReVanced Manager, you can find the contribution guidelines [here](/CONTRIBUTING.md).
97+
To build a ReVanced Manager, you can follow the [documentation](/docs).
9098

91-
### 🔴 Issues
99+
### 📄 Documentation
92100

93-
For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/choose).
101+
You can find the documentation for ReVanced Manager [here](/docs).
94102

95103
## ⚖️ License
96104

97-
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.
105+
ReVanced Manager is licensed under the GPLv3 license. Please see the [license file](LICENSE) for more information.
106+
[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.
107+
Any modifications to ReVanced Manager must also be made available under the GPL, along with build & install instructions.

docs/0_prerequisites.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
11
# 💼 Prerequisites
22

3-
In order to use ReVanced Manager, certain requirements must be met.
3+
To use ReVanced Manager, an certain requirements had to be met.
44

55
## 🤝 Requirements
66

7-
- An Android device running Android 8 or higher
7+
- Android device running Android 8.0 or higher
8+
- System that support running at least arm64-v8a, armeabi-v7a, x86_64, or x86 application
9+
10+
### Additional Requirements
11+
12+
> [!NOTE]
13+
> These requirement(s) are not required to be met,
14+
> but will provide extra functionalit(ies) to ReVanced Manager.
15+
16+
- Rooted Android device with [KernelSU](https://github.com/tiann/KernelSU) v1.0.1 or [Magisk](https://github.com/topjohnwu/Magisk) v25.2 or higher
817

918
## ⏭️ What's next
1019

docs/1_installation.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
# ⬇️ Installation
22

3-
In order to use ReVanced on your Android device, ReVanced Manager must be installed.
3+
To use ReVanced on your Android device, ReVanced Manager have to be install,
4+
refer to the [Prerequisites](0_prerequisites.md) if haven't already.
45

56
## ✅ Installation steps
67

7-
1. Download the latest version of ReVanced Manager from [here](https://github.com/ReVanced/revanced-manager/releases/latest)
8+
1. Get the latest version of ReVanced Manager from
9+
the [ReVanced site](https://revanced.app/download)
10+
or [GitHub releases](https://github.com/ReVanced/revanced-manager/releases/latest).
811
2. Install ReVanced Manager
912

1013
## ⏭️ What's next

0 commit comments

Comments
 (0)