diff options
| author | Philipp Janda <siffiejoe@gmx.net> | 2015-01-22 04:31:22 +0100 |
|---|---|---|
| committer | Philipp Janda <siffiejoe@gmx.net> | 2015-01-22 04:31:22 +0100 |
| commit | a2f72ce618a120c4299641c7fa2038caff890b30 (patch) | |
| tree | 3ba1c2f80dae9e6f456ab444e9da82808503416d /README.md | |
| parent | 665c3b6ef1e8ff795637a4362201eb87450ffb86 (diff) | |
| download | lua-compat-5.3-a2f72ce618a120c4299641c7fa2038caff890b30.tar.gz lua-compat-5.3-a2f72ce618a120c4299641c7fa2038caff890b30.tar.bz2 lua-compat-5.3-a2f72ce618a120c4299641c7fa2038caff890b30.zip | |
update readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 11 insertions, 7 deletions
| @@ -14,7 +14,8 @@ It includes: | |||
| 14 | 14 | ||
| 15 | * _For writing Lua_: The Lua module `compat53`, which can be require'd | 15 | * _For writing Lua_: The Lua module `compat53`, which can be require'd |
| 16 | from Lua scripts and run in Lua 5.1, 5.2, and 5.3, including a | 16 | from Lua scripts and run in Lua 5.1, 5.2, and 5.3, including a |
| 17 | backport of the `utf8` module straight from the Lua 5.3 sources. | 17 | backport of the `utf8` module, the 5.3 `table` module, and the |
| 18 | string packing functions straight from the Lua 5.3 sources. | ||
| 18 | * _For writing C_: A C header and file which can be linked to your | 19 | * _For writing C_: A C header and file which can be linked to your |
| 19 | Lua module written in C, providing some functions from the C API | 20 | Lua module written in C, providing some functions from the C API |
| 20 | of Lua 5.3 that do not exist in Lua 5.2 or 5.1, making it easier to | 21 | of Lua 5.3 that do not exist in Lua 5.2 or 5.1, making it easier to |
| @@ -36,8 +37,10 @@ When run under Lua 5.3, this module does nothing. | |||
| 36 | 37 | ||
| 37 | When run under Lua 5.2 or 5.1, it replaces some of your standard | 38 | When run under Lua 5.2 or 5.1, it replaces some of your standard |
| 38 | functions and adds new ones to bring your environment closer to that | 39 | functions and adds new ones to bring your environment closer to that |
| 39 | of Lua 5.3. It also loads the backported `utf8` module automatically, | 40 | of Lua 5.3. It also tries to load the backported `utf8`, `table`, and |
| 40 | and tries to use [Roberto's struct library][1]. | 41 | string packing modules automatically. If unsuccessful, pure Lua |
| 42 | versions of the new `table` functions are used as a fallback, and | ||
| 43 | [Roberto's struct library][1] is tried for string packing. | ||
| 41 | 44 | ||
| 42 | ### C code | 45 | ### C code |
| 43 | 46 | ||
| @@ -60,9 +63,9 @@ your project: | |||
| 60 | ### Lua | 63 | ### Lua |
| 61 | 64 | ||
| 62 | * the `utf8` module backported from the Lua 5.3 sources | 65 | * the `utf8` module backported from the Lua 5.3 sources |
| 63 | * `string.pack`, `string.packsize`, and `string.unpack` if the | 66 | * `string.pack`, `string.packsize`, and `string.unpack` from the Lua |
| 64 | `struct` module is available. (`struct` is not 100% compatible | 67 | 5.3 sources or from the `struct` module. (`struct` is not 100% |
| 65 | to Lua 5.3's string packing!) | 68 | compatible to Lua 5.3's string packing!) |
| 66 | * `math.maxinteger` and `math.mininteger`, `math.tointeger`, `math.type`, | 69 | * `math.maxinteger` and `math.mininteger`, `math.tointeger`, `math.type`, |
| 67 | and `math.ult` | 70 | and `math.ult` |
| 68 | * `ipairs` respects `__index` metamethod | 71 | * `ipairs` respects `__index` metamethod |
| @@ -112,6 +115,7 @@ For Lua 5.1 additionally: | |||
| 112 | 115 | ||
| 113 | For Lua 5.1 additionally: | 116 | For Lua 5.1 additionally: |
| 114 | * `LUA_OK` | 117 | * `LUA_OK` |
| 118 | * `LUA_OP*` macros for `lua_arith` and `lua_compare` | ||
| 115 | * `lua_Unsigned` | 119 | * `lua_Unsigned` |
| 116 | * `luaL_Stream` | 120 | * `luaL_Stream` |
| 117 | * `LUA_FILEHANDLE` | 121 | * `LUA_FILEHANDLE` |
| @@ -145,7 +149,7 @@ For Lua 5.1 additionally: | |||
| 145 | * `lua_isyieldable` | 149 | * `lua_isyieldable` |
| 146 | * `lua_getextraspace` | 150 | * `lua_getextraspace` |
| 147 | * `lua_arith` (new operators missing) | 151 | * `lua_arith` (new operators missing) |
| 148 | * `lua_pushfstring` (new formats) | 152 | * `lua_pushfstring` (new formats missing) |
| 149 | * `lua_upvalueid` (5.1) | 153 | * `lua_upvalueid` (5.1) |
| 150 | * `lua_upvaluejoin` (5.1) | 154 | * `lua_upvaluejoin` (5.1) |
| 151 | * `lua_version` (5.1) | 155 | * `lua_version` (5.1) |