From 077d895094d56d6bf51dd1c745528703c5ac14ae Mon Sep 17 00:00:00 2001
From: Anton Oreskin <antono2@web.de>
Date: Wed, 21 Oct 2026 09:58:14 +0200
Subject: [PATCH] docs: explain new example and test sources

---
 README.md                       | 2 ++
 ergonomic/conveniences_test.v   | 1 +
 examples/getting_started/main.v | 2 ++
 3 files changed, 5 insertions(+)

diff --git a/README.md b/README.md
index 2b0c20e..6c82761 100644
--- a/README.md
+++ b/README.md
@@ -71,6 +71,8 @@ names and reports an error if none are found. No window or shader tools are need
 
 <!-- example: examples/getting_started/main.v -->
 ```v
+// Lists Vulkan devices through the ergonomic instance owner with explicit cleanup.
+// Requires a Vulkan loader and device, but no window or shaders.
 module main
 
 import antono2.vulkan.ergonomic as vke
diff --git a/ergonomic/conveniences_test.v b/ergonomic/conveniences_test.v
index 5b8d5f9..dda33a4 100644
--- a/ergonomic/conveniences_test.v
+++ b/ergonomic/conveniences_test.v
@@ -1,3 +1,4 @@
+// Checks format masks, acquire outcomes and invalid descriptor/cache inputs without a driver.
 module ergonomic
 
 import antono2.vulkan as vk
diff --git a/examples/getting_started/main.v b/examples/getting_started/main.v
index b28dd1d..2f84703 100644
--- a/examples/getting_started/main.v
+++ b/examples/getting_started/main.v
@@ -1,3 +1,5 @@
+// Lists Vulkan devices through the ergonomic instance owner with explicit cleanup.
+// Requires a Vulkan loader and device, but no window or shaders.
 module main
 
 import antono2.vulkan.ergonomic as vke