From d4cd8a59bf3cc1eeb8a61e41c29b8a74cd993eef Mon Sep 17 00:00:00 2001
From: PaddiM8 <paddim8@pm.me>
Date: Thu, 4 Jun 2020 19:57:48 +0200
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e1b23da
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# kalk
+Kalk is a CLI calculator that supports user-defined variables and functions. An example of what it can parse:
+
+```
+f(x, y) = sum(1, 3, (2sin4/x!)^y) + cos(n deg)
+a = 3
+f(a, 2)
+```
+`>> 1.1899401098014355`
+
+## Compiling
+1. Make sure you have `diffutils` `gcc` `make` and `m4` installed.
+2. Go into the `kalk_cli` directory.
+3. Run `cargo build --release`
+4. Grab the binary from `targets/release`