X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=README;h=7aacc48b0ef57af4397bfa263968f47727bc3df2;hp=0823a10ffac5a5ef039707fcfc71302ece7939ab;hb=0fc946af7aee27a0180ae240938c78243cafe05f;hpb=7bd78d587eda7b6d86319b466230c2b885608929

diff --git a/README b/README
index 0823a10..7aacc48 100644
--- a/README
+++ b/README
@@ -1,9 +1,44 @@
+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
+
+WHAT'S WHAT
+===========
+
+README   -- this file
+Makefile -- delegates to tools/htdocs/Makefile
+tools 	 -- the tools that make up the Widget Set
+examples -- examples of applications that use MKWS
+
+notes    -- internal documents, not for customers
+
+
+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