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 The top level bug for discussing this is
   9         https://jira.indexdata.com/browse/MKWS-1
  10 and a high-level description can be found at
  11         https://twiki.indexdata.com/twiki/bin/view/ID/MasterKeyWidgetSet
  12
  13
  14 WHAT'S WHAT
  15 ===========
  16
  17 README -- this file
  18 Makefile -- delegates to tools/htdocs/Makefile
  19 tools -- the tools that make up the Widget Set
  20 examples -- examples of applications that use MKWS
  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
  29
  30 NEWS
  31 =========
  32
  33 see tools/htdocs/NEWS
  34