aboutsummaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
authorPřemysl Janouch <p.janouch@gmail.com>2017-05-21 13:37:43 +0200
committerPřemysl Janouch <p.janouch@gmail.com>2017-05-21 13:37:43 +0200
commitd1d598f96835eb2b644bcbf4b9551f9ca89057aa (patch)
tree95e239e0f1ad15f31a5d76d6a663d0c2b7090249 /README.adoc
parentbbdd17885cbefeeb30cc6993b37d6e825c342e5a (diff)
downloadell-d1d598f96835eb2b644bcbf4b9551f9ca89057aa.tar.gz
ell-d1d598f96835eb2b644bcbf4b9551f9ca89057aa.tar.xz
ell-d1d598f96835eb2b644bcbf4b9551f9ca89057aa.zip
Update README
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc18
1 files changed, 15 insertions, 3 deletions
diff --git a/README.adoc b/README.adoc
index cfb1329..b507c9f 100644
--- a/README.adoc
+++ b/README.adoc
@@ -58,7 +58,7 @@ name and it is resolved as if `set` was called on it.
The last expression in a block is the return value.
-Special forms
+Special Forms
-------------
`quote <arg>`
@@ -77,11 +77,11 @@ values, everything else is taken as true.
`set <name> [<value>]`
-Retrieves or sets a named variable.
+Retrieve or set a named variable. The syntax sugar for retrieval is `@`.
`list`
-Returns a list of parameters. The syntax sugar for lists is `[]`.
+Return a list made of given arguments. The syntax sugar for lists is `[]`.
`if <cond> <body> [elif <cond> <body>]... [else <body>]`
@@ -127,6 +127,18 @@ Arithmetic comparisons on floating point numbers.
Simple string comparisons.
+Building and Running
+--------------------
+By default, running `make' will only build the interpreter:
+
+ $ make
+ $ ./interpreter greet.ell
+
+Install development packages for GNU Readline to get a REPL for toying around:
+
+ $ make repl
+ $ ./repl
+
Contributing and Support
------------------------
Use this project's GitHub to report any bugs, request features, or submit pull