From 86512ca2522cb3edcab07e22e9e0b8cd36928f62 Mon Sep 17 00:00:00 2001
From: William Brawner <me@wbrawner.com>
Date: Mon, 18 Nov 2024 21:59:55 -0700
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6df3086
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# Clox
+
+This is my implmementation of the `clox` programming language, as seen from [Crafting Interpreters]. It makes use of the
+[meson] build system. For convenience, there's also a `Makefile` included to simplify the (already pretty simple) meson commands.
+
+### Building
+
+```bash
+make
+```
+
+To run the tests:
+
+```bash
+make test
+```
+
+[Crafting Interpreters]: https://craftinginterpreters.com/
+[meson]: https://mesonbuild.com/