bat: Mention Single VM in the README

Update the README.md file to mention that the BAT tests can be run with Single VM and that if you are using Single VM you can initialise all the necessary environment variables by sourcing ~/local/demo.sh Signed-off-by: Mark Ryan <[email protected]>
ciao-project · Nov 3, 2016 · 6108d63 · 6108d63
1 parent 56e2ebd
commit 6108d63
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/_release/bat/README.md b/_release/bat/README.md
@@ -18,6 +18,11 @@ existing test case runner, test-cases.
 
 ## Set up
 
+The BAT tests require a running ciao cluster to execute.  This can be a
+full ciao cluster running on hundreds of nodes or a Single VM ciao cluster
+running on a single machine.  For more information about Single VM see
+(here)[https://github.com/01org/ciao/wiki/Single-Machine-Development-Environment].
+
 The BAT tests require that certain environment variables have been set before they
 can be run:
 
@@ -28,6 +33,15 @@ can be run:
 * "CIAO_ADMIN_USERNAME" - your cluster admin user name
 * "CIAO_ADMIN_PASSWORD" - your cluster admin password.
 
+Note if you are using Single VM a script will be created for you called
+~/local/demo.sh that initialises these variables to their correct
+values for the Single VM cluster.  You just need to source this file
+before running the tests, e.g.,
+
+```
+. ~/local/demo.sh
+```
+
 ## Running all the BAT tests
 
 ```