aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJan Tuomi <jans.tuomi@gmail.com>2021-11-25 10:05:01 +0200
committerJan Tuomi <jans.tuomi@gmail.com>2021-11-25 19:01:31 +0200
commit4abdbaabd69a5aac827cb4e2f98c27e5661885cf (patch)
tree4cfa84a9959eebed56d6b276c7c2e2b6ea9b8403 /README.md
parentc04609bcdb7c7952501ddffc82fb97246ae0f6d4 (diff)
Add license and readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..401671e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Tunk
+
+**Tunk** is a
+
+- strongly and dynamically typed
+- pure functional
+- interpreted
+- general use
+
+programming language. Tunk is a hobby project written for educational purposes.
+
+## Running Tunk
+
+Build the `tunk` interpreter with `cargo`:
+
+ cargo build --release
+
+Run `tunk` on a source file:
+
+ target/release/tunk run samples/sample1.tunk
+
+Run `tunk` REPL:
+
+ target/release/tunk repl
+
+## Author
+
+Jan Tuomi, <<jans.tuomi@gmail.com>>