README.md edited online with Bitbucket

[tm351-notebooks.git] / README.md

diff --git a/README.md b/README.md
index e07e00b8a13f34435ad82ec03076a3cd7cdb40f6..86f91e0a139e7f86b6646ea01fddf31863f3cdb4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,38 @@
-# README #\r
-\r
-Repo for installing & running prebuilt distribution of TM351 (production) D2 VM:\r
-\r
-* vagrant files etc
\ No newline at end of file
+# README #
+
+Repo for installing & running prebuilt distribution of TM351 (production) D2 VM:
+
+* vagrant files etc
+
+This is the package intended for distribution to students.
+
+## Usage
+
+Install Virtualbox.
+Install vagrant.
+
+To launch the virtual machine:
+
+`vagrant up`
+
+in the directory containing the Vagrantfile. Wait until the process finishes; this can take quite a long time on the first run, but is usually quicker subsequently.
+
+You should be able to go to:
+
+* `http://127.0.0.1:8888` to see the notebooks
+* `http://127.0.0.1:3334` to see the OpenRefine
+* `http://127.0.0.1:3000` to see an ssh client
+
+If the services don't seem to be running:
+
+`vagrant provision`
+
+To see a full list of vagrant commands:
+
+`vagrant`
+
+To power down the virtual machine:
+
+`vagrant suspend` or `vagrant halt`
+
+in the directory containing the Vagrantfile. Then use `vagrant up` again to restart.
\ No newline at end of file