From 6355b545e54d3d4033ce689ff77031079efc7743 Mon Sep 17 00:00:00 2001
From: Bob Polis <bob.polis@gmail.com>
Date: Tue, 26 Nov 2024 14:34:16 +0100
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f865115
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# curly — Working solution to the Krul puzzle
+
+This tool will run a small compiler which implements the language from the (Krul
+puzzle)[https://bobpolis.com/krul/]. The sources also contain an older
+implementation, to be found in the interpreter files. This could also be used as
+a drop-in replacement for the compiler, by changing the appropriate line in
+`main.cpp`.
+
+## Building
+
+Build using:
+
+`make`,
+
+but first install the dependencies:
+
+- (libsclogging)[https://git.bobpolis.com/bob/libsclogging]
+- (libscterm)[https://git.bobpolis.com/bob/libscterm]
+- (libscrequest)[https://git.bobpolis.com/bob/libscrequest]
+- libcurl
+
+## Install
+
+`sudo make install`
+
+or, on OpenBSD:
+
+`doas gmake install`
+
+## Run
+
+`curly`
+