summaryrefslogtreecommitdiffstats
path: root/libraries/zycore-c/README
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/zycore-c/README')
-rw-r--r--libraries/zycore-c/README21
1 files changed, 21 insertions, 0 deletions
diff --git a/libraries/zycore-c/README b/libraries/zycore-c/README
new file mode 100644
index 0000000000..ea6d2f598e
--- /dev/null
+++ b/libraries/zycore-c/README
@@ -0,0 +1,21 @@
+Zyan Core Library for C
+
+Internal library providing platform independent types, macros and a
+fallback for environments without LibC.
+
+Features:
+ * Platform independent types
+ - Integer types (ZyanU8, ZyanI32, ZyanUSize, ...)
+ - ZyanBool (+ ZYAN_FALSE, ZYAN_TRUE)
+ - ZYAN_NULL
+ * Macros
+ - Compiler/Platform/Architecture detection
+ - Asserts and static asserts
+ - Utils (ARRAY_LENGTH, FALLTHROUGH, UNUSED, ...)
+ * Common types
+ - ZyanBitset
+ - ZyanString/ZyanStringView
+ * Container types
+ - ZyanVector
+ - ZyanList
+ * LibC abstraction (WiP)