From b7d110460e1faef4f41a0c1f9790eb34cd06075b Mon Sep 17 00:00:00 2001
From: Kimmo Varis <kimmov@gmail.com>
Date: Sun, 24 Jul 2011 21:45:53 +0300
Subject: [PATCH] GUITESTS: Add simple readme.txt.

---
 gui/test/readme.txt | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 gui/test/readme.txt

diff --git a/gui/test/readme.txt b/gui/test/readme.txt
new file mode 100644
index 000000000..3a11d7a48
--- /dev/null
+++ b/gui/test/readme.txt
@@ -0,0 +1,31 @@
+GUI tests + benchmark tests
+===========================
+
+As the GUI uses Qt framework, the GUI tests also use Qt's Testlib. This is
+totally different test framework than lib/cli is using. By principle each
+testcase is compiled as an own runnable binary.
+
+Compiling
+---------
+
+To compile all the tests run in root directory of tests:
+ - qmake ; make
+
+You can also (re)compile single test by CD:ing to the directory where test
+(source) resides and running:
+ - qmake ; make
+
+Running
+-------
+
+As each test is compiled as single executable binary you can run the test just
+by running the executable.
+
+If you want to run all the tests, you can run them all using the runtests.py
+-script. Just run the script in the tests root folder:
+ - ./runtests  in linux
+ - python runtests.py  in Windows
+
+The script runs all the test binaries it founds and then outputs the total
+number of tests passed / failed (or not run).
+