From 9798e708f500f426ad201183ba265509b5a734e1 Mon Sep 17 00:00:00 2001
From: Niko Ehrenfeuchter <nikolaus.ehrenfeuchter@unibas.ch>
Date: Wed, 7 Mar 2018 00:07:48 +0100
Subject: [PATCH] Add README for ATxConfigTest.

---
 ATxConfigTest/README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 ATxConfigTest/README.md

diff --git a/ATxConfigTest/README.md b/ATxConfigTest/README.md
new file mode 100644
index 0000000..4f18a88
--- /dev/null
+++ b/ATxConfigTest/README.md
@@ -0,0 +1,41 @@
+# AutoTx Configuration Validator
+
+The `AutoTxConfigTest` tool can be used to validate a set of configuration files
+and print a summary to the console.
+
+## Basic Usage
+
+By default, configuration files are expected to be in the same directory as the
+`AutoTxConfigTest` executable. In that case simply run the tool like this:
+
+```
+.\AutoTxConfigTest.exe
+```
+
+## Advanced Usage
+
+Instead of checking the config files in the directory of the executable, any
+other path can be specified as the first parameter when running the
+configuration validator, e.g.
+
+```
+.\AutoTxConfigTest.exe C:\Temp\new-config\
+```
+
+This also works with UNC paths, like
+
+```
+.\AutoTxConfigTest.exe \\some.file.server\share\new-config\
+```
+
+To increase the log level of the parser, a second parameter can be specified as
+either `debug` or `trace`:
+
+```
+.\AutoTxConfigTest.exe  C:\Temp\new-config\  trace
+.\AutoTxConfigTest.exe  .  debug
+```
+
+## Exit Codes
+
+A valid configuration will result in exit code `0`, an invalid in `-1`.
\ No newline at end of file
-- 
GitLab