update readme

This commit is contained in:
2026-04-11 10:40:20 -05:00
parent 2c9463c336
commit 7b4f04d54c

View File

@@ -12,14 +12,14 @@ Ouros is a rudimentary 3D rendering application built with C++ utilizing the Vul
- shmunguss
## Roadmap
Below is some steps to organize development plan and future goals, mostly following Sascha's guide.
Below is some steps to organize development plan and future goals, mostly following Sascha's guide. Might change once I know what I'm doing (I won't).
- [x] Repo setup
- [x] Hello world application
- [ ] Window creation (glfw or sdl)
- [x] Window creation (~~glfw~~ or sdl)
- [ ] Vulkan installation
- [ ] Hello Vulkan: instance creation
- [ ] Device/GPU Setup
- [ ] Graphic pipeline -> swapchain
- [ ] Graphics pipeline -> swapchain
- [ ] Shaders
- [ ] Hello triangle
- [ ] 3D
@@ -40,10 +40,10 @@ Below is beyond Sascha's guide, but available elsewhere on his github. These are
## Build instructions
### Dependencies:
- CMake > 3.2
- C++20 compatible compiler (I use g++12 or MSVC++17)
- CMake (im using 4.0.0)
- C++20 compatible compiler (I use g++12 or MSVC++17) (probably works with mingw but I haven't tested it myself)
- Vulkan compatible gpu drivers (tested with an RTX3070 and an R9700)
- SDL3
- SDL3 (im using version 3.4.4)
- Will add more as the project grows
### Clone respository:
@@ -52,12 +52,14 @@ $ git clone https://git.vxbard.net/homeburger/ouros.git --recursive
```
### Configure and build project:
```bash
$ cmake -S . -B build -DSDL3_PATH="${SDL3_INSTALL_PATH}"
$ cmake -S . -B build -DSDL3_PATH="${SDL3_INSTALL_PATH}" # either set this variable or substitute it in
$ cmake --build build -j
```
### Execute application:
```bash
$ ./build/ouros
# or on windows:
.\build\Debug\ouros.exe
```
## Additional Resources