# mal - Make a Lisp
+[![Build Status](https://travis-ci.org/kanaka/mal.svg?branch=master)](https://travis-ci.org/kanaka/mal)
+
## Description
Mal is a Clojure inspired Lisp interpreter.
-Mal is implemented in 33 different languages:
+Mal is implemented in 43 different languages:
+* GNU awk
* Bash shell
* C
* C++
* C#
* Clojure
* CoffeeScript
+* Crystal
+* Elixir
* Erlang
+* ES6 (ECMAScript 6 / ECMAScript 2015)
+* F#
* Factor
* Forth
* Go
+* Groovy
* GNU Guile
* Haskell
* Java
* JavaScript ([Online Demo](http://kanaka.github.io/mal))
* Julia
+* Kotlin
* Lua
* GNU Make
* mal itself
* PHP
* Postscript
* Python
+* RPython
* R
* Racket
* Ruby
* Rust
* Scala
* Swift
+* Tcl
+* Vimscript
* Visual Basic.NET
## Building/running implementations
+### GNU awk
+
+*The GNU awk implementation was created by [Miutsuru kariya](https://github.com/kariya-mitsuru)*
+
+The GNU awk implementation of mal has been tested with GNU awk 4.1.1.
+
+```
+cd gawk
+gawk -O -f stepX_YYY.awk
+```
+
### Bash 4
```
coffee ./stepX_YYY
```
+### Crystal
+
+*The Crystal implementation of mal was created by [Linda_pp](https://github.com/rhysd)*
+
+The Crystal implementation of mal has been tested with Crystal 0.8.0.
+
+```
+cd crystal
+crystal run ./stepX_YYY.cr
+ # OR
+make # needed to run tests
+./stepX_YYY
+```
+
+### Elixir
+
+*The Elixir implementation was created by [Martin Ek (ekmartin)](https://github.com/ekmartin)*
+
+The Elixir implementation of mal has been tested with Elixir 1.0.5.
+
+```
+cd elixir
+mix stepX_YYY
+# Or with readline/line editing functionality:
+iex -S mix stepX_YYY
+```
+
### Erlang
*The Erlang implementation was created by [Nathan Fiedler (nlfiedler)](https://github.com/nlfiedler)*
-The Erlang implementation of mal requires [Erlang/OTP R17](http://www.erlang.org/download.html) and [rebar](https://github.com/rebar/rebar) to build.
+The Erlang implementation of mal requires [Erlang/OTP R17](http://www.erlang.org/download.html)
+and [rebar](https://github.com/rebar/rebar) to build.
```
cd erlang
./stepX_YYY
```
+### ES6 (ECMAScript 6 / ECMAScript 2015)
+
+The ES6 implementation uses the [babel](https://babeljs.io) compiler
+to generate ES5 compatible JavaScript. The generated code has been
+tested with Node 0.12.4.
+
+```
+cd es6
+make
+node build/stepX_YYY.js
+```
+
+
+### F# ###
+
+*The F# implementation was created by [Peter Stephens (pstephens)](https://github.com/pstephens)*
+
+The F# implementation of mal has been tested on Linux using the Mono
+F# compiler (fsharpc) and the Mono runtime (version 3.12.1). The mono C#
+compiler (mcs) is also necessary to compile the readline dependency. All are
+required to build and run the F# implementation.
+
+```
+cd fsharp
+make
+mono ./stepX_YYY.exe
+```
+
### Factor
*The Factor implementation was created by [Jordan Lewis (jordanlewis)](https://github.com/jordanlewis)*
```
cd factor
-FACTOR_ROOTS=src factor -run=stepX_YYY
+FACTOR_ROOTS=. factor -run=stepX_YYY
```
### Forth
gforth stepX_YYY.fs
```
-### GNU Guile 2.1+
-
-*The Guile implementation was created by [Mu Lei (NalaGinrut)](https://github.com/NalaGinrut).*
-
-```
-cd guile
-guile -L ./ stepX_YYY.scm
-```
-
### Go
The Go implementation of mal requires that go is installed on on the
```
+### Groovy
+
+The Groovy implementation of mal requires Groovy to run and has been
+tested with Groovy 1.8.6.
+
+```
+cd groovy
+make
+groovy ./stepX_YYY.groovy
+```
+
+### GNU Guile 2.1+
+
+*The Guile implementation was created by [Mu Lei (NalaGinrut)](https://github.com/NalaGinrut).*
+
+```
+cd guile
+guile -L ./ stepX_YYY.scm
+```
+
### Haskell
Install the Haskell compiler (ghc/ghci), the Haskell platform and
### Julia
-The Julia implementation of mal has been tested with Julia 0.3.7.
+The Julia implementation of mal requires Julia 0.4.
```
cd julia
julia stepX_YYY.jl
```
+### Kotlin
+
+*The Kotlin implementation was created by [Javier Fernandez-Ivern](https://github.com/ivern)*
+
+The Kotlin implementation of mal has been tested with Kotlin 1.0.0-beta.
+
+```
+cd kotlin
+make
+java -jar stepX_YYY.jar
+```
+
### Lua
Running the Lua implementation of mal requires lua 5.1 or later,
make -f stepX_YYY.mk
```
-### Nim 0.10.3
+### Nim 0.11.0
*The Nim implementation was created by [Dennis Felsing (def-)](https://github.com/def-)*
-Running the Nim implementation of mal requires Nim's current devel branch
-(0.10.3) or later, and the nre library installed.
+Running the Nim implementation of mal requires Nim 0.11.0 or later.
```
cd nim
gs -q -dNODISPLAY -I./ stepX_YYY.ps
```
-### Python (2 or 3)
+### Python (2.X or 3.X)
```
cd python
python stepX_YYY.py
```
+### RPython
+
+You must have [rpython](https://rpython.readthedocs.org/) on your path
+(included with [pypy](https://bitbucket.org/pypy/pypy/)).
+
+```
+cd rpython
+make # this takes a very long time
+./stepX_YYY
+```
+
### R
The R implementation of mal requires R (r-base-core) to run.
*The Swift implementation was created by [Keith Rollin](https://github.com/keith-rollin)*
-The Swift implemenation of mal requires the Swift 1.2 compiler (XCode
-6.3) to build.
+The Swift implementation of mal requires the Swift 2.0 compiler (XCode
+7.0) to build. Older versions will not work due to changes in the
+language and standard library.
```
cd swift
./stepX_YYY
```
+### Tcl 8.6
+
+*The Tcl implementation was created by [Dov Murik](https://github.com/dubek)*
+
+The Tcl implementation of mal requires Tcl 8.6 to run. For readline line
+editing support, install tclreadline.
+
+```
+cd tcl
+tclsh ./stepX_YYY.tcl
+```
+
+### Vimscript
+
+*The Vimscript implementation was created by [Dov Murik](https://github.com/dubek)*
+
+The Vimscript implementation of mal requires Vim to run. It has been tested
+with Vim 7.4.
+
+```
+cd vimscript
+./run_vimscript.sh ./stepX_YYY.vim
+```
+
### Visual Basic.NET ###
The VB.NET implementation of mal has been tested on Linux using the Mono
make test^step7
```
-* To run tests for a specifc step against a single implementation:
+* To run tests for a specific step against a single implementation:
```
make test^IMPL^stepX
### Generating language statistics
-* To report line and byte stastics for a single implementation:
+* To report line and byte statistics for a single implementation:
```
make stats^IMPL
make stats^js
```
-* To report line and bytes stastics for general Lisp code (env, core
+* To report line and bytes statistics for general Lisp code (env, core
and stepA):
```
make stats-lisp^IMPL
needed to run tests against all the implementations (except for MATLAB
which is proprietary/licensed).
-Build the the docker image using a provided script. WARNING: this will
+Build the docker image using a provided script. WARNING: this will
likely take over an hour to build from scratch and use more 3 GB of disk:
```bash
./tests/docker-build.sh
Mal (make-a-lisp) is licensed under the MPL 2.0 (Mozilla Public
License 2.0). See LICENSE.txt for more details.
-