mirror of
https://github.com/eliasstepanik/voxel-simulation.git
synced 2026-01-11 13:58:30 +00:00
docs: expand README with running instructions
This commit is contained in:
parent
233bd74a20
commit
3a974d9d58
15
README.md
15
README.md
@ -1,6 +1,21 @@
|
|||||||
# voxel-simulation
|
# 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.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Running
|
||||||
|
|
||||||
|
Execute the following command from the repository root to compile and
|
||||||
|
launch the demo:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cargo run --release -p voxel-simulation
|
||||||
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user