From 1624559e7b4522ce28a935e24a3d5c04b197a1c8 Mon Sep 17 00:00:00 2001
From: mlokr <jdoka@crownsterling.io>
Date: Sat, 15 Jun 2024 10:46:53 +0200
Subject: [PATCH] little guide to add examples

---
 hblang/README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/hblang/README.md b/hblang/README.md
index 570ed404..24679b33 100644
--- a/hblang/README.md
+++ b/hblang/README.md
@@ -2,6 +2,20 @@
 
 ### Examples
 
+Examples are also used in tests, to and an example that runs during testing add:
+<pre>
+    #### <name>
+
+    ```hb
+    <example>
+    ```
+</pre>
+and also:
+```rs
+<name> => README;
+```
+to the `run_tests` macro at the bottom of the `src/codegen.rs`.
+
 #### directives
 ```hb
 Type := struct {