AppPkg: Add the Lua interpreter and library.

[mirror_edk2.git] / AppPkg / Applications / Lua / ReadMe.txt

diff --git a/AppPkg/Applications/Lua/ReadMe.txt b/AppPkg/Applications/Lua/ReadMe.txt
new file mode 100644 (file)
index 0000000..60ddb9d
--- /dev/null
+++ b/AppPkg/Applications/Lua/ReadMe.txt
@@ -0,0 +1,30 @@
+This is Lua 5.2.3, released on 11 Nov 2013.\r
+\r
+For installation instructions, license details, and\r
+further information about Lua, see doc/readme.html.\r
+=================================================\r
+\r
+Embedding Lua\r
+-------------\r
+The Lua library instance, LuaLib, is defined by StdLib.inc.  Since, currently, all applications which\r
+embed Lua are also StdLib applications, StdLib.inc will be included by your package's .DSC file.\r
+\r
+The header files required to use LuaLib are in the standard include path at StdLib\Include\Lua.\r
+They may be referenced as:\r
+  #include  <Lua/lua.h>\r
+  #include  <Lua/lualib.h>\r
+  #include  <Lua/lauxlib>\r
+  #include  <Lua/luaconf.h>\r
+\r
+Lua/luaconf.h is the Lua configuration file.  If you wish to build Lua with custom characteristics,\r
+this is the file to modify.  Modify the file in StdLib\Include\Lua since the file in the Lua\r
+source tree is just a stub which references the file in StdLib.\r
+\r
+\r
+Installation on UEFI\r
+--------------------\r
+Install the Lua.efi file into \Efi\Tools.   This is the standalone Lua interpreter.\r
+Create a directory, \Efi\StdLib\lib\Lua.    This is the default location for Lua scripts.\r
+\r
+If desired, copy the files from AppPkg\Applications\Lua\scripts, in the source tree, into\r
+\Efi\StdLib\lib\Lua.\r