Add READMEs.

2 files changed, 29 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..c6a6110
--- /dev/null
+++ b/README
@@ -0,0 +1,16 @@
+CIAT-Tester | Continuous Integration and Automated Test: Tester
+===============================================================
+
+This is for testing system images.  As parameters, it takes
+the URL for the system image to be tested, the testing backend
+to use, and a list of test command files to run.  For example:
+
+    ./test-runner.sh file:///test.img openstack tests/uname.test
+
+Given this, it will fetch the image, in this case `test.img`
+and it will try to test it on openstack.  The results are
+logged to `test.img.test.log`.
+
+
+See the README the the specific backend you want to use, for
+backend-specific information.
diff --git a/openstack/README b/openstack/README
new file mode 100644
index 0000000..6faa4e0
--- /dev/null
+++ b/openstack/README
@@ -0,0 +1,13 @@
+CIAT-Tester: Openstack backend
+==============================
+
+You should ensure that the openstack environment variables are set
+up correctly before running this, as the nova and glance clients
+require them.
+
+You will need to configure the script for your environment editing
+the config section of `do-tests.sh`.  Specifically you need to set
+up the flavour and network ID to use.
+
+Currently the openstack script assumes that there are floating ips
+available.