Merge pull request #26 from kristoferssolo/readme

README.md

@@ -1,12 +1,41 @@
 # Maze Ascension: The Labyrinth of Echoes
 
-"Maze Ascension: The Labyrinth of Echoes" is a minimalist maze exploration
+A procedurally generated 3D maze game built with Rust and Bevy game engine.
-game built using the Bevy engine. The game features simple visuals with
+Navigate through hexagonal maze levels that become progressively more
-hexagonal tiles forming the maze structure on a white background with black
+challenging as you ascend.
-borders, and a stickman-style player character. Players navigate through
+[Play on itch.io](https://kristoferssolo.itch.io/maze-ascension)
-multiple levels of increasing difficulty, progressing vertically as they
+
-climb up through levels. The game includes power-ups and abilities hidden
+## Features
-throughout the maze, and later introduces the ability to move between levels
+
-freely. This unique blend of puzzle-solving, exploration, and vertical
+- Procedurally generated hexagonal mazes
-progression offers a fresh twist on traditional maze gameplay, presented in
+- Multiple floor levels with increasing difficulty
-an accessible and clean visual style.
+- Smooth floor transitions and animations
+- Power-up system (WIP)
+- Custom hexagonal grid library implementation
+
+## Installation
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/kristoferssolo/maze-ascension.git
+cd maze-ascension
+```
+
+2. Build and run:
+
+```bash
+just native-release
+# or
+cargo run --release --no-default-features
+```
+
+## License
+
+This project is licensed under the GPLv3 License - see the [LICENSE](./LICENSE) file for details.
+
+## Acknowledgments
+
+- [Bevy Game Engine](https://bevyengine.org/)
+- [Red Blob Games' Hexagonal Grids](https://www.redblobgames.com/grids/hexagons/) article for hexagonal grid mathematics
+- [hexx](https://github.com/ManevilleF/hexx) for hexagonal grid inspiration

README.norg

@@ -1,11 +0,0 @@
-* Maze Ascension: The Labyrinth of Echoes
-  "Maze Ascension: The Labyrinth of Echoes" is a minimalist maze exploration
-  game built using the Bevy engine. The game features simple visuals with
-  hexagonal tiles forming the maze structure on a white background with black
-  borders, and a stickman-style player character. Players navigate through
-  multiple levels of increasing difficulty, progressing vertically as they
-  climb up through levels. The game includes power-ups and abilities hidden
-  throughout the maze, and later introduces the ability to move between levels
-  freely. This unique blend of puzzle-solving, exploration, and vertical
-  progression offers a fresh twist on traditional maze gameplay, presented in
-  an accessible and clean visual style.

justfile

@@ -8,7 +8,7 @@ native-dev:
 
 # Run native release
 native-release:
-   RUSTC_WRAPPER=sccache  cargo run --release --no-default-features
+   RUSTC_WRAPPER=sccache cargo run --release --no-default-features
 
 # Run web dev
 web-dev: