commit

examples/HelloUI/README.md

@@ -0,0 +1,36 @@
+# HelloWindow Example
+
+## Description
+
+This example demonstrates how to draw pixels to a window.
+
+## Expected Result
+
+A window with a green and blue colored square, when clicking on the square it logs the coordinates relative to the square.
+
+##  Highlighted Code Snippet
+
+```cpp
+UiElement& element = window.elements.emplace_back(
+    0.5,
+    0.5, 
+    2,
+    1,
+    0.5f,
+    0.5f,
+    0.5,
+    0.5,
+    0,
+    false 
+);
+```
+
+## How to Run
+
+```bash
+crafter-build -c example -r
+```
+
+## Relevant documentation
+
+[UiElement](https://crafter-graphics.docs.catcrafts.net/classCrafter_1_1UiElement.html)