Readme

README.md

@@ -0,0 +1,29 @@
+# Vulk-triangle
+
+---
+
+Basic rainbow triangle rendered with Vulkan.
+
+Created as a reference project while following the [official tutorial located here](https://docs.vulkan.org/tutorial/latest/00_Introduction.html)l
+
+## Compiling
+
+---
+
+Scripts for Linux are located in ./scripts/.
+
+Make sure you have a CPP compiler, CMake, and ninja installed.
+
+- `configure-{type].sh` - Creates and configures the associated build type in ./build/{type}.
+- `build-{type}.sh` - Builds the associated build type in ./build/{type}.
+- `build.sh` - Configures and builds all types in ./build/
+- `clean.sh` - Runs `ninja clean` on all build types
+
+If you are on linux and don't wish you build using the scripts you can go through
+the follow steps.
+
+1. `mkdir -p build || build`;
+2. `cmake ../`;
+3. `cmake -j 8`
+
+Windows users, you're on your own. (sorry)