From: Mike Taylor <mike@indexdata.com>
Date: Thu, 9 Oct 2014 15:12:11 +0000 (+0100)
Subject: Merge branch 'master' of ssh://git.indexdata.com/home/git/pub/mkws
X-Git-Tag: 1.0.0~258
X-Git-Url: http://sru.miketaylor.org.uk/?a=commitdiff_plain;h=c0fa14a68f3d3136d29b58fdd2d8b3f32dd7555a;hp=46011122542be3802f8c78f76c113059b9bc26da;p=mkws-moved-to-github.git

Merge branch 'master' of ssh://git.indexdata.com/home/git/pub/mkws
---

diff --git a/README b/README
index 3144b20..0bd6a6f 100644
--- a/README
+++ b/README
@@ -1,44 +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.
 
-
-WHAT'S WHAT
-===========
-
 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 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. Looks like you need node and npm, 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 1.3.0 and available by npm:
-
-  npm install handlebars@1.3.0 -g
-
-For apache setup, see tools/apache2/README
-
-NEWS
-=========
-
-see tools/htdocs/NEWS
+For more documentation:
 
+doc/README.markdown -- overview
+doc/mkws-manual.markdown -- how to use the widget set
+doc/mkws-developer.markdown -- how to develop and customise widgets
diff --git a/doc/mkws-developer.markdown b/doc/mkws-developer.markdown
index f0340a2..f4b9919 100644
--- a/doc/mkws-developer.markdown
+++ b/doc/mkws-developer.markdown
@@ -3,6 +3,28 @@
 % 11 August 2014
 
 
+Required development 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 pandoc yui-compressor libbsd-resource-perl
+
+You also need Node.js, but unfortunately the `node-js` package is not
+available for Debian wheezy. You can either get it from
+wheezy-backports or download the source from
+http://nodejs.org/download/ and build it yourself. You need both Node
+itself and its package manager NPM: `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
+
+
 Overview
 ========
 
diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown
index e76a1da..810ee4e 100644
--- a/doc/mkws-manual.markdown
+++ b/doc/mkws-manual.markdown
@@ -40,7 +40,7 @@ extent. Against this backdrop, we introduced MKWS (the MasterKey
 Widget Set) -- a set of simple, very high-level HTML+CSS+JavaScript
 components that can be incorporated into any web-site to provide
 MasterKey searching facilities. By placing `<div>`s with well-known
-identifiers in any HTML page, the various components of an application
+MKWS classes in any HTML page, the various components of an application
 can be embedded: search-boxes, results areas, target information, etc.
 
 
diff --git a/examples/htdocs/mike.html b/examples/htdocs/mike.html
index 3b87e10..69a070a 100644
--- a/examples/htdocs/mike.html
+++ b/examples/htdocs/mike.html
@@ -8,15 +8,6 @@
       }
     </script>
     <link rel="stylesheet" type="text/css" href="//mkws.indexdata.com/mkws.css" />
-<!--
-    <script type="text/javascript" src="tools/htdocs/mkws-complete.js"></script>
--->
-    <script type="text/javascript" src="tools/htdocs/jquery-1.10.0.min.js"></script>
-    <script type="text/javascript" src="tools/htdocs/jquery.json-2.4.js"></script>
-    <script type="text/javascript" src="tools/htdocs/handlebars-v2.0.0.js"></script>
-    <script type="text/javascript" src="tools/htdocs/pz2.js"></script>
-    <script type="text/javascript" src="tools/htdocs/mkws.js"></script>
-<!--
     <script type="text/javascript" src="tools/htdocs/jquery-1.10.0.min.js"></script>
     <script type="text/javascript" src="tools/htdocs/jquery.json-2.4.js"></script>
     <script type="text/javascript" src="tools/htdocs/handlebars-v2.0.0.js"></script>
@@ -35,7 +26,6 @@
     <script type="text/javascript" src="src/mkws-widget-reference.js"></script>
     <script type="text/javascript" src="src/mkws-widget-builder.js"></script>
     <script type="text/javascript" src="src/mkws-templates.js"></script>
--->
   </head>
   <body>
     <div class="mkwsAuthname"></div>
diff --git a/notes/using-mkadmin b/notes/using-mkadmin
deleted file mode 100644
index 0d78b94..0000000
--- a/notes/using-mkadmin
+++ /dev/null
@@ -1,4 +0,0 @@
-The set of targets provided by MKWS by default can be maintained using
-MKAdmin.  Go to
-	http://mkc-admin.indexdata.com/console/
-and act as the "DEMO MKWS: the MasterKey Widget Set" library administrator.