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 notes -- internal documents, not for customers
  17
  18
  19 Required devel tools
  20 ====================
  21
  22 on debian, you will need:
  23 $ sudo apt-get install curl git-core pandoc yui-compressor
  24
  25 NEWS
  26 =========
  27
  28 see tools/htdocs/NEWS
  29