From 32ff1b18c098200cc9aff3306cbf0bde6e9db0ed Mon Sep 17 00:00:00 2001
From: Arek <ar@ar76.eu>
Date: Sat, 13 Jun 2026 10:07:07 +0200
Subject: [PATCH] doc: Added README and AGENTS files

---
 AGENTS.md | 36 ++++++++++++++++++++++++++++++++++++
 README.md |  3 +++
 2 files changed, 39 insertions(+)
 create mode 100644 AGENTS.md
 create mode 100644 README.md

diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 0000000..c301ce1
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,36 @@
+# wlgol
+
+Simple implementation of Conway's Game of Life for Wayland.
+
+It directly uses C interfaces of Wayland.
+
+Uses pure C language in C11 standard.
+
+Draws directly into the buffer in a shared memory pool. Doesn't use interfaces like OpenGL, Vulkan etc.
+
+Build definition is in `CMakeFiles.txt`.
+
+Uses `cmake` an `ninja` to build the program.
+
+## Useful commands:
+
+Init build environment:
+
+```bash
+mkdir build
+cd build
+cmake -G Ninja ..
+```
+
+Build programs:
+
+```bash
+cmake --build ./build
+```
+
+Run program:
+
+```bash
+./build/wlgol
+```
+
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..45f1912
--- /dev/null
+++ b/README.md
@@ -0,0 +1,3 @@
+# wlgol
+
+Simple implementation of Conway's Game of Life for Wayland.