Create README.md

eugeneia · Oct 8, 2016 · e6fc702 · e6fc702
1 parent 0dda7b2
commit e6fc702
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/lua5.1-tests/README.md b/lua5.1-tests/README.md
@@ -0,0 +1,18 @@
+# Lua 5.1 Test Suite
+
+This directory contains a modified version of the Lua 5.1 test suite. The modifications are primarily to disable or amend some tests 
+so that the test suite can be run. 
+
+## Running the test suite
+
+You need to have `luajit` on your path.
+
+On UNIX systems just execute:
+```
+./run.sh
+```
+
+## Tests disabled or ignored
+Wherever tests have been switched off or ignored a comment has been added and the code has been made conditional. These failures will
+be investigated and either the tests will be modified or permanently disabled depending upon whether the issue is one of compatibility 
+or a defect in LuaJIT.