X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=README;h=98645e522786fad4fa0c89f690fda089484502ef;hp=c3996cb97aea8ffd0bacca716c4a035a9c4d2348;hb=172cbfe894f84b595d7bce78528596a6b6612df4;hpb=eee7160fffd700c2f4776b2585af1c620b12f99a

diff --git a/README b/README
index c3996cb..98645e5 100644
--- a/README
+++ b/README
@@ -1,32 +1,21 @@
-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.
-
-The top level bug for discussing this is
-        https://jira.indexdata.com/browse/MKWS-1
-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
-
+The MasterKey Widget Set, or MKWS, provides HTML/JS/CSS widgets that
+can be dropped into ANY website, irrespective of CMS or lack thereof,
+to enable MasterKey searching.
+
+README   -- this file
+LICENSE  -- The GNU LGPL (Lesser General Public Licence)
+Makefile -- delegates to tools/htdocs/Makefile
+src      -- source-code that is compiled into the tools area
+tools 	 -- the tools that make up the Widget Set
+examples -- examples of applications that use MKWS
+doc      -- documentation (in Markdown, compiles to HTML)
+test     -- regression-testing scripts
+notes    -- internal documents, not for customers
+
+See tools/htdocs/NEWS for the change-log.
+
+For more documentation:
+
+doc/index.markdown -- overview
+doc/mkws-manual.markdown -- how to use the widget set
+doc/mkws-developer.markdown -- how to develop and customise widgets