From 80e3f1a91677a59f95251c35b2c3d9518a4d7754 Mon Sep 17 00:00:00 2001
From: Alexander Rosenberg <zanderpkg@pm.me>
Date: Thu, 28 Aug 2025 05:03:58 -0700
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..41eb284
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# RefCount
+
+RefCount is a reference counting (thus the name) and garbage collection library
+for C. It is currently WIP and unfinished.
+
+### Building
+
+You can build using:
+```sh
+cmake -B build
+make -C build
+```
+
+You can then run tests using:
+```sh
+make -C build test
+```
+
+### Documentation
+
+You can generate documentation with:
+```
+doxygen
+```
+
+For now, you can look in the `test/` directory for some examples of the various
+features of RefCount in use.