From fa10d64aeee7423ee389d1d0e456f253790edb96 Mon Sep 17 00:00:00 2001
From: Sara <sara@saragerretsen.nl>
Date: Thu, 25 Jan 2024 14:33:30 +0100
Subject: [PATCH] feat: added readme

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8422741
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# SARA'S C UTILITIES (C UTES)
+
+A collection of utilities I keep copying around/reimplementing for various C projects.
+
+## utilities:
+- debug: some debug logging and assertion macros using stdio.
+- typeclass_helpers: macros to help with typeclasses.
+- mirror: a mirror typeclass that uses macros to enable casting typeclass instances to other typeclass instances.
+- drop: a drop typeclass to destroy objects.
+- variant: a variant struct, mainly useful in combination with dictionaries for (de-)serialization
+- vmath: float and int vector math
+- strutil: some string utilities
+- list: a heap-allocated dynamically sized list.
+- dictionary: a heap-allocated string-key hashmap.