From a99fa5a745af9eb0a047c7ced0a5849bcdb749fa Mon Sep 17 00:00:00 2001 From: TheClashFruit Date: Thu, 10 Aug 2023 14:04:00 +0200 Subject: [PATCH 1/3] docs: better title thing --- README.md | 59 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 43 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 251ece0..a4ff9b7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +

+ Cluttered Creative Icon +

+

Cluttered Creative

@@ -12,22 +16,7 @@ License (MIT)

-

- Bring back the old cluttered creative inventory. -

- -## Building - -TBA - -## Contributing - -TBA - -## Download (soon) - -

curseforge @@ -35,4 +24,42 @@ TBA curseforge -

\ No newline at end of file +

+ +

+ Bring back the old cluttered creative inventory. +

+ +## Developing + +still TBA + +## Contributing + +also still TBA + +## License + +``` +The MIT License (MIT) + +Copyright (c) 2023 TheClashFruit + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. +``` \ No newline at end of file From 61b2f5c16dcc10ca42a2080d4c29ddd2bd598ebb Mon Sep 17 00:00:00 2001 From: TheClashFruit Date: Thu, 10 Aug 2023 16:18:54 +0200 Subject: [PATCH 2/3] fix: fix cf link (used the legacy website link) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a4ff9b7..f1a5043 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ curseforge - + curseforge

From 3f812367cb0f0f6852c7b1e7053998e176a6f957 Mon Sep 17 00:00:00 2001 From: TheClashFruit Date: Thu, 10 Aug 2023 16:35:32 +0200 Subject: [PATCH 3/3] 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