From ac237b4a9aaf705ffad68801c2db93f27f2f6fff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Fri, 5 Feb 2021 18:09:12 +0100 Subject: update readme --- README.md | 28 ++++++++++++---------------- 1 file changed, 12 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 74e140b..ad6af5d 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,32 @@ # Sylt-lang ------------ + Sylt is a statically checked and dynamically typed reference counted programming language made for game jams. - ## Why does this exist? Why use this instead of language X? + Pfft! Why not? - ## Getting started -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. +Sylt is written entirely in Rust. There are two main ways of using it. +1. Depend on this repository in your Cargo.toml. +2. Clone this repository and cargo build. You can then pass .sy-files to the + resulting binary. Currently this way won't give you any kind of game. ## 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. +The `-p` flag also lets you see a lot of debug output. If you want +to debug the compiler and runtime this might be helpful. ## Endgame + A language that has some form of static typechecking, is easy and fast to work -in. Performance should be good enought that you don't really have to worry -about it. +in. Performance should be good enough that you don't really have to worry about +it. Dreams also exist of automatically updating the game when files are changed. -- cgit v1.2.1