little guide to add examples

2024-06-15 10:46:53 +02:00 · 2024-06-15 10:46:53 +02:00 · 1624559e7b
parent 1ca5d89644
commit 1624559e7b
1 changed files with 14 additions and 0 deletions
--- 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 {