documentation

example/HelloWindow/README

@@ -0,0 +1,26 @@
+# HelloWindow Example
+
+## Description
+
+This example demonstrates the minimal code needed to create a window and show it on the screen.
+
+## Expected Result
+
+A empty window with the title "HelloWindow" shows onscreen.
+
+##  Highlighted Code Snippet
+
+```cpp
+WindowWaylandWayland window("HelloWindow", 1280, 720);
+window.StartSync();
+```
+
+## How to Run
+
+```bash
+crafter-build -c example -r
+```
+
+## Relevant documentation
+
+