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
+
+

example/HelloWindow/main.cpp

@@ -0,0 +1,39 @@
+/*
+Crafter®.Graphics
+Copyright (C) 2025 Catcrafts®
+Catcrafts.net
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 3.0 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
+*/
+
+import Crafter.Graphics;
+using namespace Crafter;
+
+int main() {
+    /*
+        This creates a window titled "HelloWindow" with a size of 1280x720 pixels. 
+        The WindowWaylandWayland class is a specialized window implementation
+        that uses the Wayland display server protocol and renderer (hence the name "WaylandWayland").
+    */
+    WindowWaylandWayland window("HelloWindow", 1280, 720);
+
+    /*
+        This starts the window’s main event loop, allowing it to respond to user input and system events.
+        The window will remain open and responsive until it is closed.
+        You can hook into various events through the event system.
+        This call blocks the current thread; to run the event loop asynchronously, use StartAsync instead.
+    */
+    window.StartSync();
+}

example/HelloWindow/project.json

@@ -0,0 +1,22 @@
+{
+    "name": "crafter-graphics",
+    "configurations": [
+        {
+            "name": "example",
+            "standard": "c++26",
+            "source_files": ["main"],
+            "module_files": [],
+            "build_dir": "build",
+            "output_dir": "bin",
+            "type":"executable",
+            "libs": [],
+            "flags": ["-Wno-uninitialized"],
+            "dependencies": [
+                {
+                    "path":"../../project.json",
+                    "configuration":"lib-debug"
+                }
+            ]
+        }
+    ]
+}