luwra/README.md

Luwra

A header-only C++ library which provides a Lua wrapper with minimal overhead.

Usage

Refer to the wiki pages. In order to use the library you must clone this repository and add its lib/ folder to your include path.

Requirements

You need a C++14-compliant compiler and at least Lua 5.1 to get this library to work.

Tests

The attached GNU Makefile allows you to run both examples and tests using make examples and make test respectively. You might need to adjust LUA_* variables, so Luwra finds the Lua headers and library.

Assuming all headers are located in /usr/include/lua5.3 and the shared object name is liblua5.3.so, you need to invoke this:

make LUA_INCDIR=/usr/include/lua5.3 LUA_LIBNAME=lua5.3 test

Results on recent versions of Arch Linux and FreeBSD:

Compiler	Lua 5.1*	Lua 5.2*	Lua 5.3
clang++ 3.5	partial	partial	passes
clang++ 3.6	partial	partial	passes
g++ 5.1	partial	partial	passes

^* Assertions relying on lua_Integer will fail, due to integer quirks in Lua. This should only concern you if your application expects Lua integers to work like normal integers, because they don't.