aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoel Kronqvist <joel.kronqvist@iki.fi>2025-08-23 10:52:23 +0300
committerJoel Kronqvist <joel.kronqvist@iki.fi>2025-08-23 10:52:23 +0300
commitef4eb90eac9d99c1f677baca5ddaca2afbc1627f (patch)
tree6d61d1697d92a3f3eb2d93f5d5ed2f98eff54e53
parent485cf739e241732a167920eb0d9af0d53c0facb7 (diff)
downloadmyslip-ef4eb90eac9d99c1f677baca5ddaca2afbc1627f.tar.gz
myslip-ef4eb90eac9d99c1f677baca5ddaca2afbc1627f.zip
doc: updated the README, still sysreqs missing
-rw-r--r--README.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/README.md b/README.md
index f5881f1..3f62d29 100644
--- a/README.md
+++ b/README.md
@@ -23,9 +23,15 @@ Valid myslip s-expressions may be atoms of different types
or lists of them, though not all syntactically valid
myslip expressions are ones that can be evaluated.
+The following is s-expressions explained intuitively in
+something that looks a bit like a BNF:
+```
S-expression := Atom | List
-Atom := TODO
+Atom := Operator | Value | Variable ...
List := (S-expression ... S-expression)
+```
+Don't take it to be exact. For example lists are actually
+implemented as linked lists.
The myslip interpreter performs type checking on
s-expressions and evaluates them according to polish
@@ -65,7 +71,9 @@ $ myslip
Exit the REPL by pressing CTRL+C, CTRL+D or entering "exit".
For a quick reference on how to use the `myslip` command,
-see `myslip --help`.
+see `myslip --help`. It also contains additional features
+which are omitted here as they are not relevant for
+grading.
Running `myslip filename.slip` tries to read a file named
`filename.slip` as an s-expression and evaluates it.