Clean up the top-level README

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

diff --git a/README b/README
index 2d702a4..5b6a98b 100644 (file)
--- a/README
+++ b/README
@@ -1,34 +1,50 @@
 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.
-
-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
+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
 ===========
 
-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
+doc      -- documentation (in Markdown, compiles to HTML)
+test     -- regression-testing scripts
+notes    -- internal documents, not for customers
 
 
 Required devel tools
 ====================
 
-on debian, you will need: 
-$ sudo apt-get install curl git-core pandoc yui-compressor
+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. 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
 
+