Adding README for the tests and cleanup the main README

Signed-off-by: Mohamed Ashiq Liyazudeen <mliyazud@redhat.com>

1 files changed, 31 insertions, 0 deletions

diff --git a/tests/README.md b/tests/README.md
new file mode 100644
index 0000000..501af35
--- /dev/null
+++ b/tests/README.md
@@ -0,0 +1,31 @@
+# Testsuite
+
+This directory contains tests for gluster-containers.
+These are tests that do not test the full stack end-to-end
+but are syntax-checks or unit-tests.
+
+## Prerequisites
+
+The Dockerfile lint tests require the 'dockerfile_lint' program.
+Install it with
+
+* `dnf install npm`, or
+* `apt-get install npm`
+
+* `npm install dockerfile_lint`
+
+Ref: https://github.com/projectatomic/dockerfile_lint
+
+The test uses ShellCheck.
+Install with
+
+* `dnf install ShellCheck`, or
+* `apt-get install shellcheck`
+
+## TODOs
+
+* Write more tests
+* More elaborate basic tests - docker build, docker run of basic commands.
+* Write full functional tests to be run in vms.
+ (like the atomic vagrant environment)
+