FyroxEngine/Fyrox
1
0
Fork 0
mirror of https://github.com/FyroxEngine/Fyrox.git synced 2026-10-12 02:02:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add quick start cmd in README.md

Browse Source 
## Why
To have faster/easier learning curve and not go through docs, would be nice to have README explain how to get started
This commit is contained in:
Artjom Kurapov
2023-09-16 12:05:48 +03:00
committed by GitHub
parent 22ec00717b
commit 6c8cc8656d
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -2
View File
@@ -213,8 +213,13 @@ These screenshots are from [rusty-shooter](https://github.com/mrDIMAS/rusty-shoo
There are many examples covering various aspects of the engine. Also don't hesitate to create an issue or ask on Discord if you need help!
## [Editor](https://github.com/FyroxEngine/Fyrox/tree/master/editor)
## Quick start
To start new project and use [Editor](https://github.com/FyroxEngine/Fyrox/tree/master/editor), run:
```sh
fyrox-template init --name fyrox_test --style 2d
cd fyrox_test
cargo run --package editor --release
```
[![editor](https://raw.githubusercontent.com/FyroxEngine/Fyrox/master/editor/screenshots/latest.png)](https://github.com/FyroxEngine/Fyrox/tree/master/editor)
## Dependencies