Explain branches in readme

This commit is contained in:
Kyle Wood 2021-06-16 02:11:04 -05:00
parent e203d90f78
commit d64a2d0f15
No known key found for this signature in database
GPG Key ID: 86AF5613ACA30CC5

View File

@ -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)