From 782e1a2ca36d9ffa238de2531232198b7c7309cf Mon Sep 17 00:00:00 2001
From: Der Teufel <der.teufel.mail@gmail.com>
Date: Thu, 30 Dec 2021 21:01:43 +0100
Subject: [PATCH] Created README with build instructions

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f8899a9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# topiku
+topiku is a simple [LISP](https://en.wikipedia.org/wiki/Lisp_(programming_language)) inspired language with [toki pona](https://tokipona.org/) keywords
+
+## Building
+To build `topiku` interpreter you need a [Zig](https://ziglang.org/) compiler (works with `master`) and [`editline`](https://github.com/troglobit/editline) installed.
+```sh
+> git clone https://git.ablecorp.us:443/der-teufel-programming/topiku.git
+> cd topiku
+> zig build
+```
+The executable is then found as `zig-out/bin/topiku`
+It is also possible to build and run using `zig build run` command.
\ No newline at end of file