Update README.md

README.md

@@ -1,47 +1,73 @@
 Sakura
 ===========
-This is a fork of Paper to optimise cannoning and provide essential features for testing and faction servers.
+This is a fork of Paper to optimise cannoning and provide essential features for cannon testing and faction servers.
 
-There are branches from the latest version to 1.19.4. If you need a 1.8.8 server jar check out the project Sakura was based on [Blossom](https://github.com/Samsuik/Blossom).
+There are branches from the latest version to 1.19.3. If you are looking for a 1.8.8 server jar check out the project Sakura was based on [Blossom](https://github.com/Samsuik/Blossom).
 
 ## There are compiled binaries on the releases page
-
 > https://github.com/Samsuik/Sakura/releases
 
-## Requirements (Source, Compiling)
+## Compiling
+### Requirements
+* Git
+* JDK 21
 
-### Windows (you need [Git Bash](https://git-scm.com/download/win) and a JDK)
+### Getting setup
-> You can use command prompt on if Git is installed, make sure you to not include the `./` at the start of the gradlew commands.
+#### Clone the repository
->
-> You may also have trouble with the file path length limit, there is a registry tweak you can make to remove this limitation.
-> - https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation
 
-### Linux (git and a JDK)
+To get started you will need to clone the repository
-> ...
+``` 
+git clone https://github.com/Samsuik/Sakura
+```
 
-## Obtaining the source code
+Navigate into the newly cloned repository
-> ```
+```
-> git clone https://github.com/Samsuik/Sakura
+cd Sakura
-> ```
+```
-> Navigate to the locally cloned sakura repository
-> ```
-> cd Sakura
-> ```
-> You can use `git checkout ...` to choose between branches.
-> ```
-> git checkout 1.20.6
-> ```
-> To get the source code you can view, make changes etc.
-> ```
-> ./gradlew applyPatches
-> ```
 
-## Building the project
+If you're looking for an older version of minecraft, you will need to switch branches.
-> ### 1.20.4 and earlier
+```
-> ```
+git checkout <branch name>
-> ./gradlew createReobfPaperclipJar
+```
-> ```
+The branches targeting minecraft versions before `1.21.4` have `legacy/` in front of their name.
-> ### 1.20.6 and later
+You can skip this step if you're ok with the latest version.
-> ```
+
-> ./gradlew createMojmapPaperclipJar
+#### Applying Patches
-> ```
+> If you're using Windows the file path limit causes the `applyPatches` task to fail.
+> This is because of the highly nested structure of this repository and the use of long file names.
+> There is a registry setting that can be changed to raise this limit.
+> https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation
+
+All you have to do is run the `applyPatches` task.
+```
+./gradlew applyPatches
+```
+
+If everything was successful, you should see that two directories have been created `sakura-api` and `sakura-server` these contain all the source code.
+
+If you want to switch branches after running `applyPatches`, you will need to run the `cleanCache` task.
+```
+./gradlew cleanCache
+```
+
+### Building
+The patches must be applied before building otherwise it will fail.
+
+The task used for building is different on older versions, make sure that you use the correct command.
+
+#### After 1.20.6
+```
+./gradlew createMojmapPaperclipJar
+```
+
+#### Before 1.20.6
+```
+./gradlew createReobfPaperclipJar
+```
+
+You can find the built paperclip jar under `build/libs`.
+
+## Contributing
+If you would like to contribute please read the upstream [Contributing Guideline](https://github.com/PaperMC/Paper-archive/blob/ver/1.21.3/CONTRIBUTING.md).
+
+It contains a lot of useful information on how the project is structured and how to use the build tools.