Add README files to explain the tests directory
authorWuzzy <almikes@aol.com>
Wed, 04 Oct 2017 16:09:28 +0200
changeset 12648 5bc6fb5da42f
parent 12647 ee7815bc5874
child 12649 59b46e6f36ff
Add README files to explain the tests directory
tests/README.md
tests/lua/README.md
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/README.md	Wed Oct 04 16:09:28 2017 +0200
@@ -0,0 +1,6 @@
+Directory for automated tests to test the engine.
+
+Run `ctest` in the root directory of this repository to run all tests.
+Run `ctest -R <test name>` to run only the test with the given name.
+
+This requires you to have CMake.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/lua/README.md	Wed Oct 04 16:09:28 2017 +0200
@@ -0,0 +1,3 @@
+Lua scripts for engine testing. These scripts are the same as other Lua scripts
+in Hedgewars, but you ought to call `EndLuaTest(TEST_SUCCESSFUL)` or
+`EndLuaTest(TEST_FAILED)` when the test is completed.