X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=README;h=bc64ce22cc767b395666158589d725bb67ca0f25;hb=41416249fec1b0f6253244abba3af9fe7ea3719b;hp=6e169138994cf1df8078fe3441da69c8d32ed1fe;hpb=bb5b00d30080c9f6d55d7726e9f5264800d1e61e;p=mkws-moved-to-github.git

diff --git a/README b/README
index 6e16913..bc64ce2 100644
--- a/README
+++ b/README
@@ -1,29 +1,53 @@
 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 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
+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
 
+