[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vapourismo/luwra)

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

## Usage
Refer to the [wiki pages](https://github.com/vapourismo/luwra/wiki). 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 `Makefile` allows you to run both examples and tests using `make examples` and
`make test` respectively. You might need to adjust the `LUA_*` variables, so Luwra finds the
Lua headers and library.

So far all tests have been run on recent versions of Arch Linux and FreeBSD, with following results.

 Compiler    | Lua 5.1  | Lua 5.2  | Lua 5.3
-------------|----------|----------|----------
 clang++ 3.6 | passes   | passes   | passes
 g++ 5.1     | passes   | passes   | passes

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vapourismo/luwra)

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

## Usage
Refer to the [wiki pages](https://github.com/vapourismo/luwra/wiki). 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 `Makefile` allows you to run both examples and tests using `make examples` and
`make test` respectively. You might need to adjust the `LUA_*` variables, so Luwra finds the
Lua headers and library.

So far all tests have been run on recent versions of Arch Linux and FreeBSD, with following results.

 Compiler    | Lua 5.1 <sup>*</sup>  | Lua 5.2 <sup>*</sup> | Lua 5.3
-------------|-----------------------|----------------------|----------
 clang++ 3.6 | passes                | passes               | passes
 g++ 5.1     | passes                | passes               | passes

<sup>*</sup> Assertions relying on integers are ignored, due to integer quirks in Lua.

Add note about integer assertions
readme: Add note about integer assertions
