From 1d0ca65dcbf4395e85df9980c03843df3773e6a9 Mon Sep 17 00:00:00 2001
From: Andrew Scott <git@andyscott.me>
Date: Mon, 19 Aug 2024 15:46:35 -0400
Subject: [PATCH] Added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0d9fc06
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# marCsweep
+
+A mark-and-sweep garbage collector with a simple virtual machine to perform
+allocations.
+
+## Building
+
+Compiling the project should be relatively easy, even if you aren't familiar
+with `make`.
+
+```
+git clone https://codeberg.org/andyscott/marCsweep.git
+
+cd marCsweep
+
+make release
+```
+
+That's it! The Makefile will automatically create the build directory and place
+the compiled executable there.
+
+## Notes
+
+This is a personal project that I am writing in my free time to learn more about
+garbage collection. That said, please remember that it does allocate real
+memory, which should not be taken lightly!