Skip to content

Commit 9d87ca5

Browse files
authored
Update README.md
1 parent eb3043c commit 9d87ca5

1 file changed

Lines changed: 9 additions & 11 deletions

File tree

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,11 @@
1515
- [NEXO Engine](#nexo-engine)
1616
- [Table of Contents](#table-of-contents)
1717
- [Project Overview](#project-overview)
18-
- [Game Engine](#game-engine)
1918
- [External Dependencies](#external-dependencies)
2019
- [Build the project](#build-the-project)
21-
- [Automatically with CMake Presets](#using-cmake-presets-automatic)
22-
- [Manually with CMake](#using-cmake---build-manual)
23-
- [Install the project](#install-the-project)
20+
- [Automatically with CMake Presets](#option1-using-cmake-presets-automatic-recommended)
21+
- [Manually with CMake](#option2-using-cmake-build-manual)
22+
- [Install NEXO Engine](#install-nexo-engine)
2423
- [Install via CMake](#install-via-cmake)
2524
- [Create an installer for Windows (NSIS)](#create-an-installer-for-windows-nsis)
2625
- [Create an installer for Linux (DEB)](#create-an-installer-for-linux-deb)
@@ -34,8 +33,6 @@
3433
3534
## Project Overview
3635

37-
### Game Engine
38-
3936
📸​ Interface screenshot
4037

4138
![Editor interface](https://github.com/user-attachments/assets/cb19d00c-56bc-4cdd-9f61-069375fd7b08)
@@ -57,8 +54,9 @@ https://github.com/user-attachments/assets/ea92807b-da51-4fb6-bd1d-d3c9fadf0c13
5754
## External Dependencies
5855

5956
To run this project, ensure you have the following:
60-
- **CMake**: Necessary for building the project from source.
57+
- **CMake**: Necessary for building the project from source. (version 3.28 or higher)
6158
- **C++ Compiler**: We recommend using GCC or Clang for Linux and MacOS, and MSVC for Windows.
59+
- **Git**: For cloning with submodules.
6260

6361
## Build the project
6462

@@ -71,16 +69,16 @@ git clone --recurse-submodules
7169

7270
### 2. Run cmake to generate the build files.
7371

74-
#### Using cmake presets (automatic)
72+
#### Option1: Using `CMake presets` (automatic) [Recommended]
7573

7674
```bash
77-
cmake --workflow --present=build-debug
75+
cmake --workflow --preset=build-debug
7876
```
7977

8078
> [!NOTE]
8179
> There are several presets available: `build-debug`, `build-release`, `build-coverage`, `minimal-build`, `test-debug`, and `test-coverage`.
8280
83-
#### Using cmake --build (manual)
81+
#### Option2: Using `CMake Build` (manual)
8482

8583
```bash
8684
cmake -B build
@@ -102,7 +100,7 @@ cmake --build build
102100
> [!NOTE]
103101
> For detailed instructions, visit our [Installation Guide](docs/install/README.md).
104102
105-
## Install the project
103+
## Install NEXO Engine
106104

107105
### Install via CMake
108106

0 commit comments

Comments
 (0)