diff options
| author | darylm503 <darylm503@Edk2> | 2014-11-07 20:18:01 +0000 |
|---|---|---|
| committer | darylm503 <darylm503@Edk2> | 2014-11-07 20:18:01 +0000 |
| commit | 16a5fed65808adf648004b34f98718301d718fa2 (patch) | |
| tree | 1fd24a832f20c1ce4e1e52e0020513d0d1ef5ae8 /AppPkg/Applications/Lua/ReadMe.txt | |
| parent | c058d59f40b4a95c218cd171ff976bee1ff487e2 (diff) | |
| download | edk2-platforms-16a5fed65808adf648004b34f98718301d718fa2.tar.xz | |
AppPkg: Add the Lua interpreter and library.
StdLib: Add support and include files for Lua.
The sources for the Lua standalone interpreter, as well as its library, have been added to AppPkg/Applications/Lua. The Lua library, LuaLib, can be used to embed Lua into new applications.
The Lua header files, needed for both building and embedding, are located in StdLib/Include/Lua. The original versions of these header files, in the source directory, have been converted into stubs that reference the include files in StdLib. This allows us to keep the Lua sources as close to the distributed version as possible.
Documentation is contained in the Lua/doc directory. Further information is available at www.lua.org.
Contributed-under: TianoCore Contribution Agreement 1.0
Signed Off by: Bruce Maynard <Bruce.Maynard@Emulex.Com>
Reviewed by: Daryl McDaniel <daryl.mcdaniel@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16313 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'AppPkg/Applications/Lua/ReadMe.txt')
| -rw-r--r-- | AppPkg/Applications/Lua/ReadMe.txt | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/AppPkg/Applications/Lua/ReadMe.txt b/AppPkg/Applications/Lua/ReadMe.txt new file mode 100644 index 0000000000..60ddb9d584 --- /dev/null +++ b/AppPkg/Applications/Lua/ReadMe.txt @@ -0,0 +1,30 @@ +This is Lua 5.2.3, released on 11 Nov 2013.
+
+For installation instructions, license details, and
+further information about Lua, see doc/readme.html.
+=================================================
+
+Embedding Lua
+-------------
+The Lua library instance, LuaLib, is defined by StdLib.inc. Since, currently, all applications which
+embed Lua are also StdLib applications, StdLib.inc will be included by your package's .DSC file.
+
+The header files required to use LuaLib are in the standard include path at StdLib\Include\Lua.
+They may be referenced as:
+ #include <Lua/lua.h>
+ #include <Lua/lualib.h>
+ #include <Lua/lauxlib>
+ #include <Lua/luaconf.h>
+
+Lua/luaconf.h is the Lua configuration file. If you wish to build Lua with custom characteristics,
+this is the file to modify. Modify the file in StdLib\Include\Lua since the file in the Lua
+source tree is just a stub which references the file in StdLib.
+
+
+Installation on UEFI
+--------------------
+Install the Lua.efi file into \Efi\Tools. This is the standalone Lua interpreter.
+Create a directory, \Efi\StdLib\lib\Lua. This is the default location for Lua scripts.
+
+If desired, copy the files from AppPkg\Applications\Lua\scripts, in the source tree, into
+\Efi\StdLib\lib\Lua.
|