summaryrefslogtreecommitdiff
path: root/libraries/LuaBitOp/README
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/LuaBitOp/README')
-rw-r--r--libraries/LuaBitOp/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/libraries/LuaBitOp/README b/libraries/LuaBitOp/README
new file mode 100644
index 0000000000..4a972a1cfc
--- /dev/null
+++ b/libraries/LuaBitOp/README
@@ -0,0 +1,19 @@
+Lua BitOp is a C extension module for Lua 5.1/5.2 which adds bitwise
+operations on numbers.
+
+Features
+
+* Supported functions: bit.tobit, bit.tohex, bit.bnot, bit.band,
+ bit.bor, bit.bxor, bit.lshift, bit.rshift, bit.arshift, bit.rol,
+ bit.ror, bit.bswap
+* Consistent semantics across 16, 32 and 64 bit platforms.
+* Supports different lua_Number types: either IEEE 754 doubles, int32_t
+ or int64_t.
+* Runs on Linux, *BSD, Mac OS X, Windows and probably anything else you
+ can find.
+* Simple installation on all systems. No bulky configure scripts.
+ Embedded-systems-friendly.
+* Internal self-test on startup to detect miscompiles. Includes a
+ comprehensive test and benchmark suite.
+* Compatible with the built-in bitwise operations in LuaJIT 2.0.
+* It's as fast as you can get with the standard Lua/C API.