X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=README;h=98645e522786fad4fa0c89f690fda089484502ef;hp=a0716fca680fb39d9bda33d170984d20b7bc2ffa;hb=HEAD;hpb=9d8bf7e27c93d61482c3ea113bb211de1db10d6b

diff --git a/README b/README
index a0716fc..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.
-
-
-WHAT'S WHAT
-===========
+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.
 
-Required devel tools
-====================
-
-on debian, you will need: 
-$ sudo apt-get install curl git-core pandoc yui-compressor node-js
-
-for apache setup, see tools/apache2/README
-
-NEWS
-=========
-
-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