diff -r 66a63c9609de -r b222f4d111d9 docs/readme.mdwn --- a/docs/readme.mdwn Sat Nov 07 22:36:02 2015 +0200 +++ b/docs/readme.mdwn Sat Mar 05 18:34:07 2016 +0200 @@ -1,21 +1,21 @@ # Lua scripting for MCabber -This module creates lua 5.1 or 5.2 interpreter environment and puts some lua -functions inside for your code to interact with mcabber. +This module creates lua 5.1, 5.2 or 5.3 interpreter environment and puts some +lua functions inside for your code to interact with mcabber. -Module provides mcabber command `/lua5.1` or `/lua5.2` respectively and adds -an alias `/lua` for that command. This command evaluates argument as lua code in -created by module environment. +Module provides mcabber command `/lua5.1`, `/lua5.2` or `/lua5.3` respectively +and adds an alias `/lua` for that command. This command evaluates argument as +lua code in created by module environment. -Note: If you load both versions - `lua5.1` and `lua5.2`, alias will point to -which was loaded last. +Note: If you load multiple versions, alial will point to the one, loaded last. Lua functions, available in environment are described in api reference, built -with `docgen` help. It is also available online. +with `docgen` help. It is also available +[[online|http://www.isbear.org.ua/docs/mcabber-lua/api/]]. In `examples` dir there are some example scripts, that may be used as is or for -reference. See also `README` in `examples` dir. +reference. See also `README` in `examples` dir. They may be outdated, though. # Installation @@ -50,10 +50,12 @@ # Building options -Through `make edit_cache` action you can adjust module parameters. Notably: if -you set `WANT_LUA52`, module will be built against lua5.2, even if lua5.1 is -present; you can disable aliasing `lua` command at module loading time by -unsetting `ENABLE_LUA_ALIAS`; you can adjust mcabber option names to be +Through `make edit_cache` action you can adjust module parameters. Notably: +you can specify needed lua version with `WANT_LUA` variable, though you'll +need to do that from command line at first cache generation +(-DWANT_LUA=LUAX.X), otherwise cmake will not re-discover lua package; you can +disable aliasing `lua` command at module loading time by unsetting +`ENABLE_LUA_ALIAS`; you can adjust mcabber option names to be version-specific, if you need both versions running simultaneously via `OPT_MLUA_RC` and `OPT_MLUA_DEBUG`. @@ -68,5 +70,5 @@ I will be happy to get feedback, patches, suggestions, etc. You can send me email or contact via jabber . - -- Myhailo Danylenko + -- Myhailo Danylenko