diff --git a/README.md b/README.md index 251ece0..2fc6fc9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +
+ +
+@@ -12,27 +16,85 @@
+Bring back the old cluttered creative inventory.
-## Building +## Screenshot -TBA +![Building Blocks](https://cdn-raw.modrinth.com/data/Fs6mB0ic/images/01122692525430bb275d19972e934b2126ce2792.png) -## Contributing +## FAQ -TBA +### Mod Compatibility -## Download (soon) +Probably not compatible with mods that add items to the default item groups, however a compatibility layer is planned. -- - - +### Missing Items - - - -
\ No newline at end of file +I'm doing my best to include all items including new ones from 1.20, but I might miss some so please report them on the issues page or in my [Discord server](https://discord.gg/CWEApqJ6rc). + +> Got some other questions? Feel free to ask them in my [Discord server](https://discord.gg/CWEApqJ6rc). + +## Developing & Contributing + +Development is mostly straight forward. + +### Setup + +> It is recommended that you install the [Minecraft Development](https://plugins.jetbrains.com/plugin/8327-minecraft-development) Plugin for IntelliJ IDEA. + +1. Clone the repository from your fork. +2. Open the project. +3. Run `gradle genSources` to generate the sources. +4. You can start developing! + +### Git Commit Messages + +Please use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for your commit messages. + +### Git Branches + +You can use any branch you like except main. But it is recommended to use `dev/