aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorEdvard Thörnros <edvard.thornros@gmail.com>2021-02-02 22:27:20 +0100
committerEdvard Thörnros <edvard.thornros@gmail.com>2021-02-02 22:27:20 +0100
commit4bff1f78ab170beee39577395b8311d48ad78fb4 (patch)
tree797742b6750981fc1e4065fa3290ffcbc8a5ef33 /README.md
parent2381d4fc204f040763ad352aa2b67c58f8a40b17 (diff)
downloadsylt-4bff1f78ab170beee39577395b8311d48ad78fb4.tar.gz
clearify installation and usage
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index a7083d5..74e140b 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,20 @@ Sylt is written entirely in Rust. Pointing to this Git-repo
in your Cargo.toml is the easiest way. Alternatively you can
build the interpreter and run your own programs from there.
+```
+git clone git@github.com:FredTheDino/sylt-lang.git
+cargo build --release
+```
+This will build `target/release/sylt`, wich is the interpreter.
+If you want to install it, do so.
+
+
+## Basic Usage
+Currently, Sylt can only run single files. The last filename given is
+run.
+
+The `-p` flag also lets you see alot of debug output, if you want
+to debug the program this might be helpfull.
## Endgame
A language that has some form of static typechecking, is easy and fast to work