From: Tony Hirst <tony.hirst@gmail.com>
Date: Mon, 19 Jan 2015 10:54:07 +0000 (+0000)
Subject: Update README
X-Git-Url: https://git.njae.me.uk/?p=tm351-notebooks.git;a=commitdiff_plain;h=b85766c0eb697d3e583cf647ea0dc2badcaa9c24

Update README
---

diff --git a/README.md b/README.md
index e07e00b..daa120c 100644
--- a/README.md
+++ b/README.md
@@ -2,4 +2,29 @@
 
 Repo for installing & running prebuilt distribution of TM351 (production) D2 VM:
 
-* vagrant files etc
\ No newline at end of file
+* vagrant files etc
+
+This is the package intended for distribution to students.
+
+## Usage
+
+Install Virtualbox.
+Install vagrant.
+
+To launch the virtual machine:
+
+`vagrant up`
+
+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`
\ No newline at end of file