added README.md

1 files changed, 50 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..66f61c3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+Leap Platform testing scripts
+=============================
+
+Install scripts
+---------------
+
+    cd /usr/local/bin/
+    git clone git://code.leap.se/platform_test
+
+* Make sure wherever you clone the repo, configure $PATH so you can call the scripts directly.
+
+Install leap_cli
+----------------
+
+See https://leap.se/en/docs/platform/quick-start how to install leap_cli.
+
+
+Configure platform_test scripts
+-------------------------------
+
+* edit /etc/leap/platform-test-common.cfg for common config used by all providers, 
+  see platform-test-common.cfg.example. 
+* edit /etc/leap/PROVIDER_BRANCH.cfg for provider specific config, see
+  rewire_develop.cfg.example
+
+Setup example provider
+----------------------
+
+    leap-platform-test -c /etc/leap/rewire_develop.cfg create_provider
+
+* creates new example provider
+* adds all nodes and their services, including neccessary config for successfull deploy
+
+
+    
+    leap-platform-test -c /etc/leap/rewire_develop.cfg --all bootstrap
+
+* bootstraps nodes 
+** starts node (leap local start)
+** runs leap node init on node 
+** sets up hostname and runs apt-get dist-upgrade
+** saves the initialized node (leap local save)
+** takes ~6 mins to bootstrap one node, depending on how many updates are available.
+
+Deploy nodes
+------------
+
+    leap-platform-test -c /etc/leap/rewire_develop.cfg --all reset_deploy
+
+