Merge pull request #40 from Erb3-forked/format-docs

docs: format markdown

CONTRIBUTING.md

@@ -1,30 +1,32 @@
-### Contributing to Pumpkin
+# Contributing to Pumpkin
 
 We appreciate your interest in contributing to Pumpkin! This document outlines the guidelines for submitting bug reports, feature suggestions, and code changes.
-Getting Started
 
-The easiest way to get started is by asking for help in our [discord](https://discord.gg/wT8XjrjKkf) 
+## Getting Started
+
+The easiest way to get started is by asking for help in our [discord](https://discord.gg/wT8XjrjKkf).
 
 ### How to Contribute
 
 There are several ways you can contribute to Pumpkin:
 
 - **Reporting Bugs**:
-If you encounter a bug, please search for existing issues on the issue tracker first.
-If you can't find a duplicate issue, open a new one.
-Provide a clear description of the bug, including steps to reproduce it if possible.
-Screenshots, logs, or code snippets can also be helpful.
+  If you encounter a bug, please search for existing issues on the issue tracker first.
+  If you can't find a duplicate issue, open a new one.
+  Provide a clear description of the bug, including steps to reproduce it if possible.
+  Screenshots, logs, or code snippets can also be helpful.
 - **Suggesting Features**:
-Do you have an idea on how Pumpkin can be improved? Share your thoughts by opening an issue on the issue tracker.
-Describe the proposed feature in detail, including its benefits and potential implementation considerations.
+  Do you have an idea on how Pumpkin can be improved? Share your thoughts by opening an issue on the issue tracker.
+  Describe the proposed feature in detail, including its benefits and potential implementation considerations.
 - **Submitting Pull Requests**:
-If you'd like to contribute code changes, fork the Pumpkin repository on GitHub.
-Install Rust at https://www.rust-lang.org/.
-Make your changes on your local fork and create a pull request to the main repository.
-Ensure your code adheres to the project's coding style guidelines (if any).
-Write clear and concise commit messages that describe your changes.
+  If you'd like to contribute code changes, fork the Pumpkin repository on GitHub.
+  Install Rust at [rust-lang.org](https://www.rust-lang.org/).
+  Make your changes on your local fork and create a pull request to the main repository.
+  Ensure your code adheres to the project's coding style guidelines (if any).
+  Write clear and concise commit messages that describe your changes.
 
 ### Additional Information
+
 We encourage you to comment on existing issues and pull requests to share your thoughts and provide feedback.
 Feel free to ask questions in the issue tracker or reach out to the project maintainers if you need assistance.
-Before submitting a large contribution, consider opening an issue, discussion or talk with us on our discord to discuss your approach.
+Before submitting a large contribution, consider opening an issue, discussion or talk with us on our discord to discuss your approach.

README.md

@@ -14,21 +14,24 @@ and customizable experience. It prioritizes performance and player enjoyment whi
 
 ![image](https://github.com/user-attachments/assets/7e2e865e-b150-4675-a2d5-b52f9900378e)
 
-### What Pumpkin wants to achieve:
+## What Pumpkin wants to achieve
+
 - **Performance**: Leveraging multi-threading for maximum speed and efficiency.
 - **Compatibility**: Supports the latest Minecraft server version and adheres to vanilla game mechanics.
 - **Security**: Prioritizes security by preventing known exploits.
 - **Flexibility**: Highly configurable with the ability to disable unnecessary features.
 - **Extensibility**: Provides a foundation for plugin development.
 
-### What Pumpkin will not:
+## What Pumpkin will not
+
 - Provide compatibility with Vanilla or Bukkit servers (including configs and plugins).
 - Function as a framework for building a server from scratch.
 
 > [!IMPORTANT]
 > Pumpkin is currently under heavy development.
 
-### Features (WIP)
+## Features (WIP)
+
 - [x] Configuration (toml)
 - [x] Server Status/Ping
 - [x] Login
@@ -68,31 +71,39 @@ and customizable experience. It prioritizes performance and player enjoyment whi
 Check out our [Github Project](https://github.com/users/Snowiiii/projects/12/views/3) to see current progress
 
 ## How to run
+
 There are currently no release builds, because there was no release :D.
 
 To get Pumpkin running you first have to clone it:
-```
+
+```shell
 git clone https://github.com/Snowiiii/Pumpkin.git
 cd Pumpkin
 ```
+
 You also may have to [install rust](https://www.rust-lang.org/tools/install) when you don't already have.
 
 For Now, until we don't have own chunk generation.
 You need to pregenerate the world and place it inside of the Pumpkin/ directory.
 Make sure to generate chunks close to (0,0) since that is where the player gets spawned by default.
 
 Then run:
+
 > [!NOTE]
 > This can take a while. Because we enabled heavy optimizations for release builds
-```
+
+```shell
 RUSTFLAGS="-C target-cpu=native" cargo run --release
 ```
 
 ## Contributions
+
 Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md)
 
 ## Communication
+
 Consider joining our [discord](https://discord.gg/wT8XjrjKkf) to stay up-to-date on events, updates, and connect with other members.
 
-### Thanks
-A big thanks to https://wiki.vg/ for providing valuable information used in the development of this project.
+## Thanks
+
+A big thanks to [wiki.vg](https://wiki.vg/) for providing valuable information used in the development of this project.