From 8b4837cbe9da12f008c5cd5d964114154b9dee96 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Remko=20Tron=C3=A7on?= <git@el-tramo.be>
Date: Mon, 16 Sep 2013 20:23:27 +0200
Subject: Add Sluift README

Contains only some build hints at the moment.

Change-Id: I09fc3b133e880949ad8ee33227ab35f36f3ec875

diff --git a/Sluift/README.md b/Sluift/README.md
new file mode 100644
index 0000000..8eacc2b
--- /dev/null
+++ b/Sluift/README.md
@@ -0,0 +1,21 @@
+# Sluift
+
+## Building/Installing
+
+If you have a Lua installed on your system, edit `config.py` to point the build
+to it using the `lua_libdir`, `lua_includedir`, and `lua_libname` (usually 
+only needed on Windows) variables.
+
+In case no Lua installation is found, a bundled Lua version will be used.
+Note that there are several limitations when using the bundled Lua:
+
+- The standalone Sluift binary will not support dynamic loading of modules.
+- The Sluift module will not be built
+
+The standalone executable will be placed into `Sluift/exe`, and the loadable
+Lua module in `Sluift/dll`.
+
+In order to use the Sluift Lua module, make sure it is copied to a location in the
+Lua search path (`LUA_PATH`, or the built-in path). On Linux and Mac OS X, this is
+typically `<LUA_INSTALLPREFIX>/lib/lua/<LUA_VERSION>/`. If `require 'sluift'` fails,
+the error message will give an indication what this path is.
-- 
cgit v0.10.2-6-g49f6