Create README.md
This commit is contained in:
23
README.md
Normal file
23
README.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# Vulkan Renderer
|
||||
|
||||
This project is a small Vulkan renderer written in C++ (and GLSL) with CMake as the build process.
|
||||
It currently can render basic triangles in 2D space with a given colour.
|
||||
|
||||
### Build
|
||||
|
||||
```
|
||||
mkdir build
|
||||
cd build
|
||||
cmake ..
|
||||
cmake --build .
|
||||
```
|
||||
|
||||
This will work on most operating systems and compile all C++ and GLSL code to their required binary formats.
|
||||
Then all you will need to do is run the outputted binary to see the example scene.
|
||||
|
||||
### Planed Features
|
||||
|
||||
- Texture Support
|
||||
- 3D space
|
||||
- Free camera
|
||||
- Mesh (.obj) loading
|
||||
Reference in New Issue
Block a user