md

example/VulkanCube/README.md

@@ -0,0 +1,27 @@
+# HelloWindow Example
+
+## Description
+
+This example showcases how to use the camera to get a rotating 3D cube.
+
+## Expected Result
+
+A blue tinted vulkan window with a white rotating 3D cube.
+
+##  Highlighted Code Snippet
+
+```cpp
+Camera camera(ToRadian(90), 1280.0f / 720.0f, 0.01, 512);
+camera.view = MatrixRowMajor<float, 4, 4, 1>::Translation(0, 0, -5);
+camera.Update();
+```
+
+## How to Run
+
+```bash
+crafter-build -c example -r
+```
+
+## Relevant documentation
+
+