diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f460900d0..2105c00ef5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,11 +65,11 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using ## 📝 How to contribute > [!NOTE] -> It's worth noting that we recommend that you discuss your changes with +> We recommend that you discuss your changes with > the maintainers of ReVanced Manager before contributing. > This will help you determine whether your change is acceptable. -1. Fork the repository and create your branch from `dev` +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. 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 @@ -78,6 +78,6 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using ## 🤚 I want to contribute but don't know how to code Even if you don't know how to code, you can still contribute by -translating the ReVanced Manager application on our [Crowdin](https://translate.revanced.app/). +translating ReVanced Manager on [Crowdin](https://translate.revanced.app/). ❤️ Thank you for considering contributing to ReVanced Manager. diff --git a/README.md b/README.md index 64e2c6f243..06026f4927 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,7 @@

# 💊 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 "") @@ -51,6 +52,7 @@ ReVanced Manager is an Android application that uses ReVanced Patcher to add, re ### 💪 Features We provide the some of the features are: + * 📱 **Portable**: ReVanced Patcher that fit in your pocket! * 🤗 **Intuitive UI**: Help you manage your patched applications *intuitively*! * 🛠️ **Customization**: Patch with third-party sources! diff --git a/docs/2_1_patching.md b/docs/2_1_patching.md index 9d84bfbd8e..2cb565e9c2 100644 --- a/docs/2_1_patching.md +++ b/docs/2_1_patching.md @@ -11,7 +11,8 @@ The following pages will guide you through using ReVanced Manager to patch apps. 5. Select the patches you want to apply 6. Tap the Patch button 7. Tap on the **Install** button - > [!Note]: If you are rooted, you can mount the patched app on top of the original app.[^3] + > [!Note] + > If you are rooted, you can mount the patched app on top of the original app.[^3] > Optionally, you may export the patched app to storage using the options in the top right corner. [^1]: Non-root users may be prompted to select an APK from storage, in which case you have to source the APK file yourself. ReVanced does not provide any APK files. diff --git a/docs/README.md b/docs/README.md index 0b327509db..523af847f8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,7 +14,7 @@ This documentation explains how to use [ReVanced Manager](https://github.com/ReV 3. [❔ Troubleshooting](3_troubleshooting.md) ## 👋 Developer version -Interested in contributing? Consider checking out developer version of the [documentation](/developers/README.md). +Interested in contributing? Consider checking out the developer [documentation](/developers/README.md) ## ⏭️ Start here diff --git a/docs/developers/0_preparation.md b/docs/developers/0_preparation.md index ff036652b0..154d2af82f 100644 --- a/docs/developers/0_preparation.md +++ b/docs/developers/0_preparation.md @@ -11,7 +11,7 @@ In order to compile ReVanced Manager, certain requirements must be met. ```sh git clone https://github.com/ReVanced/revanced-manager.git && cd revanced-manager ``` -2. Build the APK +2. Build the application ```sh gradlew assembleRelease ```