mirror of
https://github.com/zhenyan121/Cubed.git
synced 2026-06-17 16:17:02 +08:00
docs: add build guide
This commit is contained in:
19
README.md
19
README.md
@@ -1,2 +1,21 @@
|
|||||||
## What's it
|
## What's it
|
||||||
A cube game like Minecraft, using C++ and OpenGL.
|
A cube game like Minecraft, using C++ and OpenGL.
|
||||||
|
|
||||||
|
## Build Guide
|
||||||
|
### Prerequisites
|
||||||
|
- **CMake** (>= 3.24)
|
||||||
|
- **C++ 23** compatible compiler
|
||||||
|
### Step
|
||||||
|
1. Clone the repository
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/zhenyan121/Cubed.git && cd Cubed
|
||||||
|
```
|
||||||
|
2. Configure with CMake
|
||||||
|
```bash
|
||||||
|
mkdir build && cd build
|
||||||
|
cmake -G "Ninja" ..
|
||||||
|
```
|
||||||
|
3. Build the project
|
||||||
|
```bash
|
||||||
|
ninja
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user