Use the LGPL instead of the GPL.
[mkws-moved-to-github.git] / README
diff --git a/README b/README
index 6e16913..7aacc48 100644 (file)
--- a/README
+++ b/README
@@ -9,18 +9,33 @@ irrespective of CMS or lack thereof, to enable MasterKey searching.
 WHAT'S WHAT
 ===========
 
-README -- this file
+README   -- this file
 Makefile -- delegates to tools/htdocs/Makefile
-tools -- the tools that make up the Widget Set
+tools   -- the tools that make up the Widget Set
 examples -- examples of applications that use MKWS
-notes -- internal documents, not for customers
+
+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. 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
 =========