diff --git a/README.md b/README.md index 3bb7b07d0..115261a1e 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,8 @@ For an example repository, see [ReVanced Patches](https://github.com/revanced/re 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](build.gradle.kts) file (Specifically, the [group of the project](build.gradle.kts#L10), [manifest attributes](build.gradle.kts#L37-L47), and the [POM](build.gradle.kts#L98-L121)) +2. Set up the [build.gradle.kts](build.gradle.kts) file (Specifically, the [group of the project](build.gradle.kts#L10), [manifest attributes](build.gradle.kts#L37-L47), +and the [POM](build.gradle.kts#L98-L121)) 3. Update dependencies in the [libs.versions.toml](gradle/libs.versions.toml) file 4. [Create a pass-phrased GPG master key and subkey](https://mikeross.xyz/create-gpg-key-pair-with-subkeys/) 1. Add the private key as a secret named [GPG_PRIVATE_KEY](.github/workflows/release.yml#L43) to your repository @@ -18,7 +19,8 @@ To start using this template, follow these steps: 3. Add the fingerprint of the GPG subkey as a secret named [GPG_FINGERPRINT](.github/workflows/release.yml#L45) to your repository 6. [Create a PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) with [push access](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/ci-configuration.md#authentication) 1. Add it as a secret named [REPOSITORY_PUSH_ACCESS](.github/workflows/release.yml#L49) to your repository -7. Set up the [README.md](README.md) file[^1] (e.g, title, description, license, summary of the patches that are included in the repository) +7. Set up the [README.md](README.md) file[^1] (e.g, title, description, license, summary of the patches +that are included in the repository) 🎉 You are now ready to start creating patches! @@ -42,17 +44,26 @@ To develop and release ReVanced Patches using this template, some things need to - The `dev` branch is merged into the `main` branch once it is ready for release - Semantic versioning is used to version ReVanced Patches. ReVanced Patches have a public API for other patches to use - Semantic commit messages are used for commits -- Commits on the `dev` branch and `main` branch are automatically released via the [release.yml](.github/workflows/release.yml) workflow, which is also responsible for generating the changelog and updating the version of ReVanced Patches. It is triggered by pushing to the `dev` or `main` branch. The workflow uses the `publish` task to publish the release of ReVanced Patches -- To build ReVanced Patches that can be used on Android, the [`buildDexJar`](build.gradle.kts#L50-L73) task must be run. The [`publish` task depends on the `buildDexJar`](build.gradle.kts#L78) task, so it will be run automatically when publishing a release. +- Commits on the `dev` branch and `main` branch are automatically released +via the [release.yml](.github/workflows/release.yml) workflow, which is also responsible for generating the changelog +and updating the version of ReVanced Patches. It is triggered by pushing to the `dev` or `main` branch. +The workflow uses the `publish` task to publish the release of ReVanced Patches +- To build ReVanced Patches that can be used on Android, the [`buildDexJar`](build.gradle.kts#L50-L73) task must be run. +The [`publish` task depends on the `buildDexJar`](build.gradle.kts#L78) task, +so it will be run automatically when publishing a release. ## 📚 Everything else ### 🛠️ Building -To build ReVanced Patches template, you can follow the [ReVanced documentation](https://github.com/ReVanced/revanced-documentation). +To build ReVanced Patches template, +you can follow the [ReVanced documentation](https://github.com/ReVanced/revanced-documentation). ## 📜 Licence -ReVanced Patches template is licensed under the GPLv3 licence. Please see the [license file](LICENSE) for more information. -[tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3) you may copy, distribute and modify ReVanced Patches template as long as you track changes/dates in source files. -Any modifications to ReVanced Patches template must also be made available under the GPL, along with build & install instructions. +ReVanced Patches template is licensed under the GPLv3 licence. +Please see the [license file](LICENSE) for more information. +[tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3) you may copy, distribute +and modify ReVanced Patches template as long as you track changes/dates in source files. +Any modifications to ReVanced Patches template must also be made available under the GPL, +along with build & install instructions.