add Readme

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "lib/Unity"]
 	path = lib/Unity
-	url = gitea@gitea.stubbe.rocks:3rd-party/Unity.git
+	url = https://github.com/ThrowTheSwitch/Unity.git

README.md

@@ -0,0 +1,51 @@
+# KUnity
+
+KUnity configure the c unit test framework Unity (http://www.throwtheswitch.org/unity) so that it can use in kernel space. The test results will be "shown" by `printk`.
+
+## Add KUnity to a kernel module
+
+```Makefile
+
+# add KUnity and Unity source files
+module-objs += lib/KUnity/src/kunity.o
+module-objs += lib/KUnity/lib/Unity/src/unity.o
+
+# include KUnity and Unity header
+ccflags-y += -I<lib_path>/KUnity/src
+ccflags-y += -I<lib_path>/KUnity/lib/Unity/src
+
+# set the unity config by header file flag, which is provided by KUnity
+ccflags-y += -DUNITY_INCLUDE_CONFIG_H
+```
+
+##  Write and Running test cases
+
+Test can be written like Unity tests, but for the definition of the test function you have to use the  ```KUNITY_TEST``` makro.
+When a kunity test should run, its necessary to add the prefix  ```kunity_test_``` to the test function name.
+
+```c
+#include <kunity.h>
+// ... application includes
+KUNITY_TEST(first_simple_test)
+{
+    TEST_ASSERT_EQUAL(1, 0);
+}
+
+// add more tests
+
+// run tests
+int module_init(void) {
+    int result = 0;
+    UNITY_BEGIN();
+    RUN_TEST(kunity_test_first_simple_test);
+    // ... call the other tests
+    result = UNITY_END();
+    if ( < 1) {
+        // all tests was successful, startup module
+        // ...
+    }
+
+    return -result;
+}
+```
+For running tests it can also use the [KUnity-Test-Runner-Module](https://github.com/stubbfel/KUnity-Test-Runner-Module)

src/kunity.c

@@ -4,21 +4,6 @@
 #include <linux/slab.h>
 #include <linux/string.h>
 
-//}
-//{ local include region
-
-//}
-
-//{ local define region
-
-//}
-
-//{ local enum region
-
-//}
-
-//{ local typedef region
-
 //}
 
 //{local struct region
@@ -40,7 +25,7 @@ static result_code_e set_test_output(/*in */ const ptr_test_session_control_bloc
 
 //{ local  var region
 
-static test_session_control_block_s prink_output = { printk_put_char,0 ,0 };
+static test_session_control_block_s prink_output = { printk_put_char, 0, 0 };
 
 static ptr_test_session_control_block_s kunity_output = &prink_output;
 
@@ -89,14 +74,14 @@ result_code_e run_unity_test(/* in */ const unity_test_function_ptr test_functio
         return result;
     }
 
-    if (output->_skip_start){
+    if (output->_skip_start) {
         Unity.TestFile = file_name;
     } else {
         UnityBegin(file_name);
     }
 
     UnityDefaultTestRun(test_function, test_name, line_number);
-    if (!output->_skip_end){
+    if (!output->_skip_end) {
         UNITY_END();
     }
 

src/kunity.h

@@ -3,16 +3,11 @@
 #include "kunity_t.h"
 
 //{ global include region
+
 #include <unity.h>
-//}
-//{ local include region
 
 //}
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-
 //{ function region
 
 extern void putchark(/* in */ char a);
@@ -25,8 +20,4 @@ extern result_code_e run_unity_printk_test(/* in */ const kunity_test_function_p
 
 //}
 
-#ifdef __cplusplus
-}
-#endif
-
 #endif // KUNITY_H

src/kunity_t.h

@@ -6,9 +6,6 @@
 #include <linux/export.h>
 #include <linux/types.h>
 
-//}
-//{ local include region
-
 //}
 
 //{ define region