From 6c74f4582cbf9bae1209c344fc03ad549c3a10e0 Mon Sep 17 00:00:00 2001 From: zhenyan121 <3367366583@qq.com> Date: Sun, 19 Apr 2026 18:01:09 +0800 Subject: [PATCH] docs: add build guide --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aaa6078..a27d7d6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ ## What's it -A cube game like Minecraft, using C++ and OpenGL. \ No newline at end of file +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 + ``` \ No newline at end of file