From 455089d1fb1b4385e4b9867fa9665724428f30b5 Mon Sep 17 00:00:00 2001
From: Georg von Zengen <vonzengen@ibr.cs.tu-bs.de>
Date: Mon, 17 Oct 2016 21:17:57 +0200
Subject: [PATCH] README: some more documentation
---
README.md | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/README.md b/README.md
index 4c8b726..fdd2186 100644
--- a/README.md
+++ b/README.md
@@ -15,3 +15,25 @@ It some special printf commands that are passed by the test suite
#define TEST_REPORT(desc, value, scale, unit) printf("TEST:REPORT:%s:%lu:%lu:%s\n", (desc), ((uint32_t)value), ((uint32_t)scale), (unit))
#define TEST_RESULT(desc, value) printf("TEST:RESULT:%s:%s\n", (desc), (value))
```
+
+In the `test/example_configs` there are some simple examples how to configure testcases, the test-suite, and how to tell the suite which devices are how/where connected.
+
+`test/test.py` is the executable, it takes the following parameters:
+```
+optional arguments:
+ -h, --help show this help message and exit
+ -l, --list only list what tests/devices are defined
+ -d, --dirty don't clean the projects
+ -r, --reset-only don't build and upload
+ -s SUITE_CONFIGFILE, --suite-config SUITE_CONFIGFILE
+ where to read the test suite config from
+ -t TEST_CONFIGFILE, --test-config TEST_CONFIGFILE
+ where to read the test config from
+ -n NODE_CONFIGFILE, --node-config NODE_CONFIGFILE
+ where to read the executing nodes config from
+ -x XMLREPORT, --xml XMLREPORT
+ output the test reports in XML (for easy parsing with
+ jenkins), takes path to XML-report-dir as argument
+ --only-tests ONLY_TESTS
+ only run the tests defined on the commandline
+```
--
GitLab