README

   1 OVERVIEW
   2 ========
   3
   4 The MasterKey Widget Set, or MKWS, is a project to create some very
   5 simple HTML/JS/CSS widgets that can be dropped into ANY website,
   6 irrespective of CMS or lack thereof, to enable MasterKey searching.
   7
   8
   9 WHAT'S WHAT
  10 ===========
  11
  12 README   -- this file
  13 Makefile -- delegates to tools/htdocs/Makefile
  14 tools    -- the tools that make up the Widget Set
  15 examples -- examples of applications that use MKWS
  16
  17 notes    -- internal documents, not for customers
  18
  19
  20 Required devel tools
  21 ====================
  22
  23 On debian, you will need:
  24 $ sudo apt-get install curl git-core pandoc yui-compressor node-js libbsd-resource-perl
  25
  26 On Debian 7 (wheezy), you do not need git-core, plain git will do, but
  27 you probably have that on a development box already. Unfortunately, node-js
  28 is not available for wheezy. Either you can get it from wheezy-backports,
  29 or you can download the source from http://nodejs.org/download/ and build
  30 it yourself. Looks like you need node and npm, make install puts them
  31 into /usr/local/bin.
  32
  33 To compile the default templates you'll need to install the stable version
  34 of Handlebars. Currently it's at 1.3.0 and available by npm:
  35
  36   npm install handlebars@1.3.0 -g
  37
  38 For apache setup, see tools/apache2/README
  39
  40 NEWS
  41 =========
  42
  43 see tools/htdocs/NEWS
  44