X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=README;h=c3996cb97aea8ffd0bacca716c4a035a9c4d2348;hb=01f372e7e7c05590585bae4348e701782539a9bd;hp=0823a10ffac5a5ef039707fcfc71302ece7939ab;hpb=7bd78d587eda7b6d86319b466230c2b885608929;p=mkws-moved-to-github.git

diff --git a/README b/README
index 0823a10..c3996cb 100644
--- a/README
+++ b/README
@@ -1,3 +1,6 @@
+OVERVIEW
+========
+
 The MasterKey Widget Set, or MKWS, is a project to create some very
 simple HTML/JS/CSS widgets that can be dropped into ANY website,
 irrespective of CMS or lack thereof, to enable MasterKey searching.
@@ -7,3 +10,23 @@ The top level bug for discussing this is
 and a high-level description can be found at
         https://twiki.indexdata.com/twiki/bin/view/ID/MasterKeyWidgetSet
 
+
+WHAT'S WHAT
+===========
+
+experiments -- a directory containing code experiments:
+	jquery-ui -- Using a JQuery UI element
+	jsdemo -- The basic pazpar2 client, running locally
+	spclient -- Mike's hardly-there sketch
+	spdemo -- Wolfram's functioning jsdemo-targeted-at-SP
+
+etc -- configuration files for the various experiments
+	apache2 -- configuration for running spdemo
+	service-proxy -- config for running a local Service Proxy
+
+
+Required devel tools
+====================
+
+on debian, you will need: curl git-core pandoc
+