forth: Add . interop special operator and tests

[jackhill/mal.git] / README.md

diff --git a/README.md b/README.md
index 7ed6a7b..c444b27 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,48 +2,55 @@
 
 ## Description
 
-Mal is an interpreter for a subset of the Clojure programming
-language. Mal is implemented from scratch in 18 different languages:
+Mal is an Clojure inspired Lisp interpreter.
+
+Mal is implemented in 25 different languages:
 
 * Bash shell
 * C
 * C#
 * Clojure
 * CoffeeScript
+* Forth
 * Go
+* Haskell
 * Java
 * Javascript ([Online Demo](http://kanaka.github.io/mal))
+* Lua
 * GNU Make
 * mal itself
+* MATLAB
+* OCaml
 * Perl
 * PHP
 * Postscript
 * Python
 * R
+* Racket
 * Ruby
 * Rust
 * Scala
 * Visual Basic.NET
 
 
-Mal is also a learning tool. Each implementation of mal is separated
-into 11 incremental, self-contained (and testable) steps that
-demonstrate core concepts of Lisp. The last step is capable of
-self-hosting (running the mal implemenation of mal).
+Mal is a [learning tool](process/guide.md). Each implementation of mal is separated into 11
+incremental, self-contained (and testable) steps that demonstrate core
+concepts of Lisp. The last step is capable of self-hosting (running
+the mal implemenation of mal).
 
 The mal (make a lisp) steps are:
 
-* step0_repl
-* step1_read_print
-* step2_eval
-* step3_env
-* step4_if_fn_do
-* step5_tco
-* step6_file
-* step7_quote
-* step8_macros
-* step9_try
-* stepA_interop
+* [step0_repl](process/guide.md#step0)
+* [step1_read_print](process/guide.md#step1)
+* [step2_eval](process/guide.md#step2)
+* [step3_env](process/guide.md#step3)
+* [step4_if_fn_do](process/guide.md#step4)
+* [step5_tco](process/guide.md#step5)
+* [step6_file](process/guide.md#step6)
+* [step7_quote](process/guide.md#step7)
+* [step8_macros](process/guide.md#step8)
+* [step9_try](process/guide.md#step9)
+* [stepA_interop](process/guide.md#stepA)
 
 
 Mal was presented publicly for the first time in a lightning talk at
@@ -99,8 +106,18 @@ cd coffee
 coffee ./stepX_YYY
 ```
 
+### Forth
+
+```
+cd forth
+gforth stepX_YYY.fs
+```
+
 ### Go
 
+You Go implementation of mal requires that go is installed on on the
+path. The implementation has been tested with Go 1.3.1.
+
 ```
 cd go
 make
@@ -108,6 +125,20 @@ make
 ```
 
 
+### Haskell
+
+Install the Haskell compiler (ghc/ghci), the Haskell platform and
+either the editline package (BSD) or the readline package (GPL). On
+Ubuntu these packages are: ghc, haskell-platform,
+libghc-readline-dev/libghc-editline-dev
+
+```
+cd haskell
+make
+./stepX_YYY
+```
+
+
 ### Java 1.7
 
 The Java implementation of mal requires maven2 to build.
@@ -128,6 +159,17 @@ npm update
 node stepX_YYY.js
 ```
 
+### Lua
+
+Running the Lua implementation of mal requires lua 5.1 or later,
+luarocks and the lua-rex-pcre library installed.
+
+```
+cd lua
+make  # to build and link linenoise.so
+./stepX_YYY.lua
+```
+
 ### Mal
 
 Running the mal implementation of mal involves running stepA of one of
@@ -147,6 +189,29 @@ cd make
 make -f stepX_YYY.mk
 ```
 
+### OCaml 4.01.0
+
+```
+cd ocaml
+make
+./stepX_YYY
+```
+
+### MATLAB
+
+The MATLAB implementation of mal has been tested with MATLAB version
+R2014a on Linux. Note that MATLAB is a commercial product. It should
+be fairly simple to support GNU Octave once it support classdef object
+syntax.
+
+```
+cd matlab
+./stepX_YYY
+matlab -nodisplay -nosplash -nodesktop -nojvm -r "stepX_YYY();quit;"
+    # OR with command line arguments
+matlab -nodisplay -nosplash -nodesktop -nojvm -r "stepX_YYY('arg1','arg2');quit;"
+```
+
 ### Perl 5.8
 
 For readline line editing support, install Term::ReadLine::Perl or
@@ -191,8 +256,18 @@ The R implementation of mal requires R (r-base-core) to run.
 
 ```
 cd r
-make libs
-Rscript stepX_YYY.rb
+make libs  # to download and build rdyncall
+Rscript stepX_YYY.r
+```
+
+### Racket (5.3)
+
+The Racket implementation of mal requires the Racket
+compiler/interpreter to run.
+
+```
+cd racket
+./stepX_YYY.rb
 ```
 
 ### Ruby (1.8)
@@ -243,7 +318,7 @@ mono ./stepX_YYY.exe
 
 ## Running tests
 
-The are nearly 400 generic Mal tests (for all implementations) in the
+The are nearly 500 generic Mal tests (for all implementations) in the
 `tests/` directory. Each step has a corresponding test file containing
 tests specific to that step. The `runtest.py` test harness uses
 pexpect to launch a Mal step implementation and then feeds the tests
@@ -288,3 +363,9 @@ make test^IMPL^stepX
 make test^ruby^step3
 make test^ps^step4
 ```
+
+## License
+
+Mal (make-a-lisp) is licensed under the MPL 2.0 (Mozilla Public
+License 2.0). See LICENSE.txt for more details.
+