feat: added readme

README.MD

@@ -0,0 +1,29 @@
+# VulkanTest
+This is a simple test application to learn how Vulkan works.
+
+It is based on this tutorial: https://vulkan-tutorial.com
+
+## Building
+This project is build using CMake.
+
+### Dependencies
+You need to have Vulkan headers, glslc and GLFW3 installed.
+These can be installed with the following packages on Arch Linux:
+ - vulkan-headers
+ - shaderc
+ - glfw-x11 (or glfw-wayland)
+
+### Validation Layers
+When `WITH_VALIDATION_LAYERS` is enabled (default). Then the package vulkan-validation-layers is also required.
+
+### JetBrains CLion
+This project is developed using JetBrains CLion. And can be build using it without any issues.
+
+Some useful plugins:
+ - GLSL Support
+
+### Other environments
+Not tested but by running cmake you can generate the make files. After that you can use make to build the binary.
+
+## Other Platforms
+This project is not tested platform other than Arch Linux. Some modification will be required before it is usable.