blob: cd5a7f2b89fb5664e3db99d5d6d657dc2439e3df [file] [log] [blame]
Vishal Bhoj82c80712015-12-15 21:13:33 +05301This is Lua 5.2.3, released on 11 Nov 2013.
2
3For installation instructions, license details, and
4further information about Lua, see doc/readme.html.
5=================================================
6
7Embedding Lua
8-------------
9The Lua library instance, LuaLib, is defined by StdLib.inc. Since, currently, all applications which
10embed Lua are also StdLib applications, StdLib.inc will be included by your package's .DSC file.
11
12The header files required to use LuaLib are in the standard include path at StdLib\Include\Lua.
13They may be referenced as:
14 #include <Lua/lua.h>
15 #include <Lua/lualib.h>
16 #include <Lua/lauxlib>
17 #include <Lua/luaconf.h>
18
19Lua/luaconf.h is the Lua configuration file. If you wish to build Lua with custom characteristics,
20this is the file to modify. Modify the file in StdLib\Include\Lua since the file in the Lua
21source tree is just a stub which references the file in StdLib.
22
23
24Installation on UEFI
25--------------------
26Install the Lua.efi file into \Efi\Tools. This is the standalone Lua interpreter.
27Create a directory, \Efi\StdLib\lib\Lua. This is the default location for Lua scripts.
28
29If desired, copy the files from AppPkg\Applications\Lua\scripts, in the source tree, into
30\Efi\StdLib\lib\Lua.
31
32Bugs and Other Issues
33---------------------
34EOF characters, ^D or ^Z, are not properly recognized by the console and can't be used to
35terminate an application. Use os.exit() to exit Lua.