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.
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
27 If you are building the widget set, as opposed to just using it, you
28 will need the following Debian packages (or their equivalents on your
31 $ sudo apt-get install curl git pandoc yui-compressor libbsd-resource-perl
33 You also need Node.js, but unfortunately the node-js package is not
34 available for Debian wheezy. You can either get it from
35 wheezy-backports or download the source from
36 http://nodejs.org/download/ and build it yourself. You need node and
37 npm, its package manager: make install puts them into /usr/local/bin.
39 To compile the default templates you'll need to install the stable version
40 of Handlebars. Currently it's at 2.0.0 and available by npm:
42 npm install handlebars@2.0.0 -g
44 For apache setup, see tools/apache2/README