docs: improved docs #1
43
README.md
43
README.md
|
@ -30,13 +30,48 @@
|
||||||
Bring back the old cluttered creative inventory.
|
Bring back the old cluttered creative inventory.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## 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/<feature>` if you add something new and `fix/<issue>` 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
|
## License
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue