diff --git a/.gitignore b/.gitignore index d8662f1..bbb26b9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ .cache .build +cmake-build vendor/vulkan compile_commands.json diff --git a/README.md b/README.md index 92f4910..0758f20 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # Window/Renderer Test -A window and a custom renderer implementation using wrappers around SDL3 and Vulkan with ability to add support for other APIs +A window and a custom renderer implementation using wrappers around SDL3 and Vulkan with ability to add support for other APIs. + +## Building + +Run the following commands to build the code + +```console +cmake -S . -B cmake-build && cmake --build cmake-build +``` + +Then run using the following command + +```console +cd cmake-build && ./main && cd ../ +```