-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. See the contents of the "doc" directory
-for further documentation.
-
-
-WHAT'S WHAT
-===========
+to enable MasterKey searching.
README -- this file
LICENSE -- The GNU LGPL (Lesser General Public Licence)
test -- regression-testing scripts
notes -- internal documents, not for customers
+See tools/htdocs/NEWS for the change-log.
-Required devel tools
-====================
-
-If you are building the widget set, as opposed to just using it, you
-will need the following Debian packages (or their equivalents on your
-operating system):
-
-$ sudo apt-get install curl git-core pandoc yui-compressor node-js libbsd-resource-perl
-
-On Debian 7 (wheezy), you do not need git-core, plain git will do, but
-you probably have that on a development box already. Unfortunately, node-js
-is not available for wheezy. Either you can get it from wheezy-backports,
-or you can download the source from http://nodejs.org/download/ and build
-it yourself. You need node and npm, its package manager: make install
-puts them into /usr/local/bin.
-
-To compile the default templates you'll need to install the stable version
-of Handlebars. Currently it's at 2.0.0 and available by npm:
-
- npm install handlebars@2.0.0 -g
-
-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