revanced-patches-template/README.md

# 👋🧩 ReVanced Patches template

This is a template for creating a new ReVanced Patches repository.  
The repository can have multiple patches, and patches from other repositories can be used together.

For an example repository, see [ReVanced Patches](https://github.com/revanced/revanced-patches).

##  🚀 Get started 

To start using this template, follow these steps:

### 1. [Create a new repository using this template](https://github.com/new?template_name=revanced-patches-template&template_owner=ReVanced)

### 2. Set up the `build.gradle.kts` file

Match the group of the project, the manifest attributes, and the POM that will be published to yours.

### 3. Update the dependencies in the `libs.versions.toml` file

Sometimes, the latest version of dependencies can be necessary, which is why keeping them up to date is important.

### 4.  Set up the `README.md` file[^1]

Add a title, a description, a license and a short summary of the patches that are included in the repository. 

🎉 You are now ready to start creating patches!

## 🔘 Optional steps

You can also add the following things to the repository:

- [Issue templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository)[^2]
- Contribution guidelines[^3]
- Documentation, if you want to publish your patches as a library[^4]

[^1]: [Example README.md file](https://github.com/ReVanced/revanced-patches/blob/main/README.md)
[^2]: [Example issue templates](https://github.com/ReVanced/revanced-patches/tree/main/.github/ISSUE_TEMPLATE)
[^3]: [Example contribution guidelines](https://github.com/ReVanced/revanced-patches/blob/main/CONTRIBUTING.md)
[^4]: [Example documentation](https://github.com/ReVanced/revanced-patches/tree/docs/docs)