Skip to content

Commit 604f4d1

Browse files
committed
README updated
1 parent 256aa2f commit 604f4d1

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ The prequisites for using this code are:
7474
- Windows 10, 11 (Although it should be easy enough to set it up for Linux).
7575
- Vulkan SDK 1.3.* installed. (With VMA and Shaderc libraries)
7676
- CMake installed.
77+
- Ninja (Optional but recommended to speed-up compilation time)
7778

7879
1. Clone the repo:
7980
```bash
@@ -87,7 +88,9 @@ The prequisites for using this code are:
8788
cmake ..
8889
```
8990

90-
The project is configured in such a way that, during the build process, CMake takes care of automatically locating and linking all dependencies on the system, with exception of the Vulkan SDK, due to its more complex installation. This has been done to facilitate an easy and lightweight distribution of the source code, sparing the user the effort of manual configuration. Although the project has been implemented in Visual Studio Code, a practical file structure has been configured for CMake in case it is opened in Visual Studio.
91+
92+
93+
The project is configured in such a way that, during the build process, CMake takes care of automatically locating and linking all dependencies on the system, with exception of the Vulkan SDK, due to its more complex installation. This has been done to facilitate an easy and lightweight distribution of the source code, sparing the user the effort of manual configuration. Although the project has been implemented in VS Code, a practical file structure has been configured for CMake in case it is opened in Visual Studio or any other IDE.
9194

9295
Once the project is opened in the IDE of choice, compile it in the desired mode, and it would be ready to run. The CMake configuration is set for a 64-bit architecture, but it can be changed. CMake also takes care of automatically configuring the paths for resource files.
9396

@@ -98,7 +101,7 @@ The project compiles dependencies, the 3D library, and the example applications
98101
cmake -DBUILD_EXAMPLES=OFF /path/to/source
99102
cmake -DBUILD_TESTS=OFF /path/to/source
100103
```
101-
4. Alternatively, you can click on the build.bat file to automatically build (in release mode) the entire project.
104+
4. Alternatively, you can click on any of the setup folder .bat files to compile and configure the project using you preferred backend. If using VS Code, you can change presents in the CMake Tools' bar.
102105

103106
## Project Integration 🗄️
104107

0 commit comments

Comments
 (0)