diff --git a/README.md b/README.md index 77e7a9d..5677afd 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,28 @@ This game engine is built with minimal libraries including no usage of libc exce It was mostly built in c99 with later changing to c23 for some features (embed directive, typed enums) but I will soon remove usage of these features and move it back to c17 for MSVC compatibility, choosing c17 for static assert functionality but otherwise the style being mostly in line with c99. +## Building + +On Linux it can be built using the below command, it requires GCC > 15.0 or a relatively recent version of Clang, the Vulkan SDK, xcb and x11 libraries. + +``` +// Release build +./build.sh release + +// Debug build +./build.sh +``` + +On Windows you can build it with the Powershell script, it will require that you enable the script to be run (build.bat will be fixed eventually to work around this). It requires the Vulkan SDK to be installed and currently needs to have the directory to the SDK includes folder in the build.ps1 script. + +``` +// Release build +.\build.ps1 release + +// Debug build +.\build.ps1 +``` + ## Inspiration/Resources I learned this style of programming primarily through Casey Muratori's series [Handmade Hero](https://guide.handmadehero.org/), I mostly picked up on the style from the earlier episodes and watched a couple of others at different points in the series as a way to learn about certain things or get ideas, though I think I have strayed somewhat from his style though the heart of it is inspired by the same core ideas.