From bde9aaa2b771eece8feea00e60a4009f6a1f18a4 Mon Sep 17 00:00:00 2001 From: simon Date: Mon, 13 Apr 2015 21:13:07 +0100 Subject: [PATCH] Enough instructions that other people actually could try playing with this. --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a80f1fc..56ce541 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,31 @@ Exploratory add-ons based on the MicroWorld engine, probably of interest only to me. +Not strictly speaking part of MicroWorld; the rest of the system works fine without this. + +## Pre-requisites + +You need **git**, **leiningen** and **mw-engine** + +How you install [git](http://git-scm.com/) depends on your operating system; look for instructions [here](http://git-scm.com/book/en/v2/Getting-Started-Installing-Git). + +To install [leiningen](http://leiningen.org/), follow the instructions [here](http://leiningen.org/#install). + +To install [mw-engine](https://github.com/simon-brooke/mw-engine), do the following: + + git clone https://github.com/simon-brooke/mw-engine.git + cd mw-engine + lein install + +You should then be good to go. + ## Usage Ideally, use lein gorilla -Then browse to the URL you're prompted with. +Then browse to the URL you're prompted with. From the menu, choose 'Load a worksheet'; currently you'll only find one. Play. ## License