From d1faad7b1943301b34913a08a7874f2e62777ba4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edvard=20Th=C3=B6rnros?= Date: Tue, 2 Feb 2021 13:48:02 +0100 Subject: simple readme --- 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..7de2dd5 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Sylt-lang +----------- +Sylt is a statically-checked dynamically typed, reference counted programming +language made for GameJams. + + +## Why does this exist? Why not use X-lang? +Pfft! Why not? + + +## Getting started +Sylt is written entirely in Rust. Pointing to this Git-repo +in your Cargo.toml is the easiet way. Alternatively you can +build the interpreter and run your own programs from there. + + +## 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. + +Dreams also exist of automatically updating the game when files are changed. -- cgit v1.2.1 From 2381d4fc204f040763ad352aa2b67c58f8a40b17 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edvard=20Th=C3=B6rnros?= Date: Tue, 2 Feb 2021 22:23:24 +0100 Subject: Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Gustav Sörnäs --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7de2dd5..a7083d5 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ # Sylt-lang ----------- -Sylt is a statically-checked dynamically typed, reference counted programming -language made for GameJams. +Sylt is a statically checked and dynamically typed reference counted programming +language made for game jams. -## Why does this exist? Why not use X-lang? +## 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 easiet way. Alternatively you can +in your Cargo.toml is the easiest way. Alternatively you can build the interpreter and run your own programs from there. -- cgit v1.2.1 From 4bff1f78ab170beee39577395b8311d48ad78fb4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edvard=20Th=C3=B6rnros?= Date: Tue, 2 Feb 2021 22:27:20 +0100 Subject: clearify installation and usage --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) 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 -- cgit v1.2.1 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