Completely rewrite overview.

[mkws-moved-to-github.git] / README

diff --git a/README b/README
index 0823a10..3b99f61 100644 (file)
--- 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
+