From 3a974d9d58e4df47ad6fcaff228500b276ab9154 Mon Sep 17 00:00:00 2001 From: Elias Stepanik <40958815+eliasstepanik@users.noreply.github.com> Date: Mon, 9 Jun 2025 22:34:00 +0200 Subject: [PATCH] docs: expand README with running instructions --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index a4427c3..9dc839d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,21 @@ # voxel-simulation +Voxel Simulation is an experimental 3D world built with the +[Bevy](https://bevyengine.org/) game engine. The project showcases +streaming voxel terrain, high precision coordinates via the +[big_space](https://crates.io/crates/big_space) crate and various debug +tools. +![Demo screenshot](images/voxel-simulation-demo.png) + +## Running + +Execute the following command from the repository root to compile and +launch the demo: + +```bash +cargo run --release -p voxel-simulation +``` ## License