X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=README;h=98645e522786fad4fa0c89f690fda089484502ef;hp=2d702a4268806564edca21eca9bde4240eeb9e90;hb=ce1503ff9f918a52ded3643ba8595d49c71e1277;hpb=f18d4ea782b37d8a56636f759ab0982bc6a5830f

diff --git a/README b/README
index 2d702a4..98645e5 100644
--- a/README
+++ b/README
@@ -1,34 +1,21 @@
-OVERVIEW
-========
+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.
 
-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
-===========
-
-README -- this file
+README   -- this file
+LICENSE  -- The GNU LGPL (Lesser General Public Licence)
 Makefile -- delegates to tools/htdocs/Makefile
-tools -- the tools that make up the Widget Set
+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
-notes -- internal documents, not for customers
-
-
-Required devel tools
-====================
-
-on debian, you will need: 
-$ sudo apt-get install curl git-core pandoc yui-compressor
+doc      -- documentation (in Markdown, compiles to HTML)
+test     -- regression-testing scripts
+notes    -- internal documents, not for customers
 
-NEWS
-=========
+See tools/htdocs/NEWS for the change-log.
 
-see tools/htdocs/NEWS
+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