From d1d598f96835eb2b644bcbf4b9551f9ca89057aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C5=99emysl=20Janouch?= Date: Sun, 21 May 2017 13:37:43 +0200 Subject: Update README --- README.adoc | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) (limited to 'README.adoc') 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 ` @@ -77,11 +77,11 @@ values, everything else is taken as true. `set []` -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 [elif ]... [else ]` @@ -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 -- cgit v1.2.3