README

   1 Lutok is a lightweight C++ API library for Lua.
   2
   3 Lutok provides thin C++ wrappers around the Lua C API to ease the
   4 interaction between C++ and Lua.  These wrappers make intensive use of
   5 RAII to prevent resource leakage, expose C++-friendly data types, report
   6 errors by means of exceptions and ensure that the Lua stack is always
   7 left untouched in the face of errors.  The library also provides a small
   8 subset of miscellaneous utility functions built on top of the wrappers.
   9
  10 Lutok focuses on providing a clean and safe C++ interface; the drawback
  11 is that it is not suitable for performance-critical environments.  In
  12 order to implement error-safe C++ wrappers on top of a Lua C binary
  13 library, Lutok adds several layers or abstraction and error checking
  14 that go against the original spirit of the Lua C API and thus degrade
  15 performance.
  16
  17 For further information on the contents of this distribution file,
  18 please refer to the following other documents:
  19
  20 * AUTHORS: List of authors and contributors to this project.
  21 * COPYING: License information.
  22 * INSTALL: Compilation and installation instructions.
  23 * NEWS: List of major changes between formal releases.
  24
  25 For general project information, please visit:
  26
  27     https://github.com/jmmv/lutok/