From d64a2d0f15085b2c731f0bf2a25faedffc5e5d8a Mon Sep 17 00:00:00 2001 From: Kyle Wood Date: Wed, 16 Jun 2021 02:11:04 -0500 Subject: [PATCH] Explain branches in readme --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index a982da8..943376a 100644 --- a/README.md +++ b/README.md @@ -35,3 +35,12 @@ rebuildPatches runDev - Spin up a non-shaded non-remapped test server runShadow - Spin up a test server from the shadowJar archiveFile ``` + +## Branches + +Each branch of this project represents an example: + + - [`main` is the standard example](https://github.com/PaperMC/paperweight-examples/tree/main) + - [`submodules` shows how paperweight can be applied on a fork using the more traditional git submodule system](https://github.com/PaperMC/paperweight-examples/tree/submodules) + - [`mojangapi` shows how a fork could patch arbitrary non-git directories (such as `Paper-MojangAPI`)](https://github.com/PaperMC/paperweight-examples/tree/mojangapi) + - [`submodules-mojang` shows the same as `mojangapi`, but on the git submodules setup from `submodules`](https://github.com/PaperMC/paperweight-examples/tree/submodules-mojangapi)