浏览代码

Update README

Ole Krüger 10 年之前
父节点
当前提交
d7c766519b
共有 1 个文件被更改,包括 11 次插入1 次删除
  1. 11 1
      README.md

+ 11 - 1
README.md

@@ -3,5 +3,15 @@
 # Luwra
 A header-only C++ library which provides a Lua wrapper with minimal overhead.
 
+## Requirements
+You need will need a C++14 compliant compiler and Lua 5.3 (or higher) installed.
+
+ Platform                | Lua 5.1  | Lua 5.2  | Lua 5.3
+-------------------------|----------|----------|---------
+ Linux (clang++ 3.6)     | untested | untested | works
+ Linux (g++ 5.1)         | untested | untested | works
+ Everything else         | untested | untested | untested
+
 ## Usage
-Refer to the [wiki pages](https://github.com/vapourismo/luwra/wiki).
+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.