1 files changed, 25 insertions, 0 deletions
diff --git a/externals/zycore/README.md b/externals/zycore/README.md
new file mode 100644
index 00000000..309a73b6
--- /dev/null
+++ b/externals/zycore/README.md
@@ -0,0 +1,25 @@
+# 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)
+
+## License
+
+Zycore is licensed under the MIT license.