lua-users home
lua-l archive

[Date Prev][Date Next][Thread Prev][Thread Next] [Date Index] [Thread Index]


2012/10/19 Rob Hoelz <rob@hoelz.ro>:


>
> That's what README.md is intended for; are there things missing from it
> that you'd like me to add?
>

# Compatibility

The current version of the software runs on Lua 5.1, LuaJIT ?.? etc.
A port to Lua 5.2 is envisaged, but is not at this stage a priority.
Since it is written purely in Lua, it should work on any platform that
has one of those versions of Lua installed.

# Installation

The directory `repl` should be in your module path, and the
file `rep.lua` in your executable path.  This can be achieved
by `luarocks ...` (please say how, the default did not work for
me) or manually.

# Recommended packages

`rep.lua` works best if you also have `linenoise` installed,
available form <supply URL>.  Without `linenoise` you will
not have command editing, file completion, history and
all the other stuff traditionally associated with `readline`.

# Features

`rep.lua` prints the result of a single expression instead of
giving (as the standalone Lua interpreter does) an error
message.  To suppress output, add a semicolon at the
end (it doesn't yet — please add that feature).

Plus any other ways in which `rep.lua` enhances the
standard shell.

Dirk