hello world

README.md

@@ -13,8 +13,8 @@ Ouros is a rudimentary 3D rendering application built with C++ utilizing the Vul
 
 ## Roadmap
 Below is some steps to organize development plan and future goals, mostly following Sascha's guide. 
-  - [ ] Repo setup
-  - [ ] Hello world application
+  - [x] Repo setup
+  - [x] Hello world application
   - [ ] Window creation (glfw or sdl)
   - [ ] Vulkan installation
   - [ ] Hello Vulkan: instance creation
@@ -38,8 +38,26 @@ Below is beyond Sascha's guide, but available elsewhere on his github. These are
   - [ ] Particles
 
 ## Build instructions
-TODO: git clone, build/install libraries script, cmake commands, etc.
-TODO: identify dependencies and how to install them (vulkan libraries, sdl, glm, etc.)
+
+### Dependencies:
+ - CMake > 3.2
+ - C++20
+ - Vulkan compatible gpu drivers (tested with an RTX3070 and an R9700)
+ - Will add more as the project grows
+
+### Clone respository:
+```bash
+$ git clone https://git.vxbard.net/homeburger/ouros.git --recursive
+```
+### Configure and build project:
+```bash
+$ cmake -S . -B build
+$ cmake --build build -j
+```
+### Execute application:
+```bash
+$ ./build/ouros
+```
 
 ## Additional Resources
  - https://howtovulkan.com/