From 3f812367cb0f0f6852c7b1e7053998e176a6f957 Mon Sep 17 00:00:00 2001 From: TheClashFruit Date: Thu, 10 Aug 2023 16:35:32 +0200 Subject: [PATCH] docs: finish new README.md --- README.md | 43 +++++++++++++++++++++++++++++++++++++++---- 1 file changed, 39 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f1a5043..2fc6fc9 100644 --- a/README.md +++ b/README.md @@ -30,13 +30,48 @@ Bring back the old cluttered creative inventory.

-## Developing +## Screenshot -still TBA +![Building Blocks](https://cdn-raw.modrinth.com/data/Fs6mB0ic/images/01122692525430bb275d19972e934b2126ce2792.png) -## Contributing +## FAQ -also still TBA +### Mod Compatibility + +Probably not compatible with mods that add items to the default item groups, however a compatibility layer is planned. + +### Missing Items + +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/` if you add something new and `fix/` if you are fixing something related to an issue. + +### Opening a Pull Request + +When you start your development please open a draft pull request. This way we can see that someone is working on select feature/bug. + +> Make sure to mention related issues/pull requests in your pull request. ## License