From dc240acb9dc84cee1f290ae3af3597f2c6c5c919 Mon Sep 17 00:00:00 2001
From: servostar <sven.vogel123@web.de>
Date: Thu, 2 May 2024 09:59:42 +0200
Subject: [PATCH] added section about writing tests to README

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index a1e442b..faca249 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,28 @@ Requires:
 - bison
 - flex
 
+## Writing Tests
+
+Since the project is build and configured through CMake it makes sense to rely for tests
+on CTest. All tests are located in the subfolder `tests`. In this directory is a CMakeLists.txt which specifies which tests
+are to be run. Actual tests are located in folders within tests and contain a final CMakeLists.txt which specifies what to run 
+for a single test.
+
+```
+tests
+  └─ test_group1
+      └─ CMakeLists.txt  # specify tests in this group
+      └─ ...             # test files of group 1
+      
+  └─ test_group2
+      └─ CMakeLists.txt  # specify tests in this group
+      └─ ...             # test files of group 2
+      
+  └─ CMakeLists.txt      # specify test groups to run
+  
+CMakeLists.txt           # build configuration
+```
+
 ## Development with VSCode/Codium
 
 Recommended extensions for getting a decent experience are the following: