templates/simple-cmake-template
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update 'README.md'

Browse Source
This commit is contained in:
wiharb
2024-03-07 07:26:43 -05:00
parent a02ff7d8e4
commit 41be05a22f
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -1,4 +1,11 @@
## Overview
A simple cmake template
- Works with VS Code and Visual Studio 2022
- Works on Windows (probably Linux as well but have not tested)
- Initialize with : `cmake -S . -B ./_build
- Pulls down 3rd party dependancies with CMake Fetch
## Structure ## Structure
```
_build/ - Location for build artifacts (gitignore) _build/ - Location for build artifacts (gitignore)
_external/ (Compiled/src 3rd party libraries and headers) _external/ (Compiled/src 3rd party libraries and headers)
assets/ - binary assets (textures, audio files, compiled shaders) assets/ - binary assets (textures, audio files, compiled shaders)
@@ -8,6 +15,6 @@ source/ (Source files for project)
LICENCE LICENCE
CMakeLists.txt CMakeLists.txt
README README
```
## Asset handling ## Asset handling
CMAKE implements `ASSETS_PATH` as either a relative or absolute path to assets/ CMAKE implements `ASSETS_PATH` as either a relative or absolute path to assets/