Table headings use "Setting" instead of "Element" for configuration items.

[mkws-moved-to-github.git] / README

diff --git a/README b/README
index 370c54e..98645e5 100644 (file)
--- a/README
+++ b/README
@@ -1,26 +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.
+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
 
-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
+See tools/htdocs/NEWS for the change-log.
 
+For more documentation:
 
-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
-
+doc/index.markdown -- overview
+doc/mkws-manual.markdown -- how to use the widget set
+doc/mkws-developer.markdown -- how to develop and customise widgets