X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=README;h=3b99f6182cad86906c699f38ebdde0c71b19d91a;hp=0823a10ffac5a5ef039707fcfc71302ece7939ab;hb=e02e942ecf467457eb8221d124dfd7d795d3d815;hpb=7bd78d587eda7b6d86319b466230c2b885608929

diff --git a/README b/README
index 0823a10..3b99f61 100644
--- a/README
+++ b/README
@@ -1,3 +1,6 @@
+OVERVIEW
+========
+
 The MasterKey Widget Set, or MKWS, is a project to create some very
 simple HTML/JS/CSS widgets that can be dropped into ANY website,
 irrespective of CMS or lack thereof, to enable MasterKey searching.
@@ -7,3 +10,19 @@ The top level bug for discussing this is
 and a high-level description can be found at
         https://twiki.indexdata.com/twiki/bin/view/ID/MasterKeyWidgetSet
 
+
+WHAT'S WHAT
+===========
+
+README -- this file
+Makefile -- delegates to tools/htdocs/Makefile
+tools -- the tools that make up the Widget Set
+examples -- examples of applications that use MKWS
+notes -- internal documents, not for customers
+
+
+Required devel tools
+====================
+
+on debian, you will need: curl git-core pandoc
+