From 1261aa9f66fdeba31783b90f66d6651a73ca8cea Mon Sep 17 00:00:00 2001
From: Bruno BELANYI <bruno@belanyi.fr>
Date: Tue, 29 Sep 2020 18:26:29 +0200
Subject: [PATCH] readme: add small explanations

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..35a7d1c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# Jitters
+
+This is a small experiment in writing a JIT-compiled calculator. It can
+pretty-print, evaluate the AST, compile to assembly, or JIT compile and
+interpret the input expression.
+
+## Building
+
+```sh
+./bootstrap # Also launches configure
+make
+```
+
+## How to use
+
+To show the different options, use:
+
+```sh
+./jitters --help
+```
+
+Once launched, you can write your expression in it's standard input.