From 0b15b555208cfe4ffcc0a61e8c144404cf853f14 Mon Sep 17 00:00:00 2001
From: Pasha Bibko <156938226+PashaBibko@users.noreply.github.com>
Date: Mon, 24 Nov 2025 20:23:10 +0000
Subject: [PATCH] Create README.md

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9909028
--- /dev/null
+++ b/README.md
@@ -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