basic tests

1 files changed, 31 insertions, 0 deletions

diff --git a/test/README b/test/README
new file mode 100644
index 0000000..4ef67e0
--- /dev/null
+++ b/test/README
@@ -0,0 +1,31 @@
+Test Files
+
+---
+
+Testing:
+
+Each test is a function wrapped in a macro
+
+KPL_TEST(my_test) {
+    // code here
+}
+
+Each test passes by default
+
+---
+
+Testing Macros:
+
+The testing framework provides two macros KPL_ASSERT and KPL_FAIL
+
+Both macros can only be used inside a KPL_TEST function
+
+Asserting:
+
+KPL_ASSSERT(condition, "Fail Message");
+
+---
+
+Failing:
+
+KPL_FAIL("The test failed");