From 41be05a22f894478f6d9dd1d3db81aa801531741 Mon Sep 17 00:00:00 2001 From: wiharb Date: Thu, 7 Mar 2024 07:26:43 -0500 Subject: [PATCH] Update 'README.md' --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5f1dc63..736df41 100644 --- a/README.md +++ b/README.md @@ -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 +``` _build/ - Location for build artifacts (gitignore) _external/ (Compiled/src 3rd party libraries and headers) assets/ - binary assets (textures, audio files, compiled shaders) @@ -8,6 +15,6 @@ source/ (Source files for project) LICENCE CMakeLists.txt README - +``` ## Asset handling CMAKE implements `ASSETS_PATH` as either a relative or absolute path to assets/