README

   1 OVERVIEW
   2 ========
   3
   4 The MasterKey Widget Set, or MKWS, provides HTML/JS/CSS widgets that
   5 can be dropped into ANY website, irrespective of CMS or lack thereof,
   6 to enable MasterKey searching. See the contents of the "doc" directory
   7 for further documentation.
   8
   9
  10 WHAT'S WHAT
  11 ===========
  12
  13 README   -- this file
  14 LICENSE  -- The GNU LGPL (Lesser General Public Licence)
  15 Makefile -- delegates to tools/htdocs/Makefile
  16 src      -- source-code that is compiled into the tools area
  17 tools    -- the tools that make up the Widget Set
  18 examples -- examples of applications that use MKWS
  19 doc      -- documentation (in Markdown, compiles to HTML)
  20 test     -- regression-testing scripts
  21 notes    -- internal documents, not for customers
  22
  23
  24 Required devel tools
  25 ====================
  26
  27 On debian, you will need:
  28 $ sudo apt-get install curl git-core pandoc yui-compressor node-js libbsd-resource-perl
  29
  30 On Debian 7 (wheezy), you do not need git-core, plain git will do, but
  31 you probably have that on a development box already. Unfortunately, node-js
  32 is not available for wheezy. Either you can get it from wheezy-backports,
  33 or you can download the source from http://nodejs.org/download/ and build
  34 it yourself. You need node and npm, its package manager: make install
  35 puts them into /usr/local/bin.
  36
  37 To compile the default templates you'll need to install the stable version
  38 of Handlebars. Currently it's at 2.0.0 and available by npm:
  39
  40   npm install handlebars@2.0.0 -g
  41
  42 For apache setup, see tools/apache2/README
  43
  44
  45 NEWS
  46 ====
  47
  48 see tools/htdocs/NEWS
  49
  50