diff --git a/.github/header.png b/.github/header.png new file mode 100644 index 00000000..54c923e8 Binary files /dev/null and b/.github/header.png differ diff --git a/README.md b/README.md new file mode 100644 index 00000000..13362358 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# BuildSystem ![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/einTosti/BuildSystem/Build%20main/master) ![version](https://img.shields.io/github/v/release/einTosti/BuildSystem) [![Discord](https://img.shields.io/discord/419460301403193344.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.com/invite/Nt467Rf) + +![Screenshot](.github/header.png) + + + +## Introduction +**BuildSystem** is a simple but powerful - as the name already says - system for builders, with lots of great features for everyday usage. +Manage worlds in the worlds navigator, change their permission, projects and status with ease. +And not to forget: let each player decide which settings whey think are best for them and now the building can start! + + +## Full guide +You can find a full guide with tutorials, commands and permissions [here](https://buildsystem.eintosti.de/). + + +## Contributing + +### Requirements +As **BuildSystem** uses NMS classes, you'll have to run [BuildTools](https://hub.spigotmc.org/jenkins/job/BuildTools/) locally first. +```java +java -jar BuildTools.jar +``` + +### Compilation +Build with `mvn clean install`. + +### PR Policy +I'll accept changes that make sense. You should be able to justify their existence, along with any maintenance costs that come with them. + +## License +This project is licensed under the [MIT License](LICENSE).