X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=README;h=927ee560ace46e622712036b67fbc2bbed366efe;hp=3144b20785c8655a592f3023684a13c9804a2ac6;hb=fbe7e5cb7b0f61e16242f4f71ef417d454a09c33;hpb=8b1e1eb12aee97f743e424860c1a2f5b4d6ffcce diff --git a/README b/README index 3144b20..927ee56 100644 --- a/README +++ b/README @@ -3,17 +3,21 @@ OVERVIEW The MasterKey Widget Set, or MKWS, provides HTML/JS/CSS widgets that can be dropped into ANY website, irrespective of CMS or lack thereof, -to enable MasterKey searching. +to enable MasterKey searching. See the contents of the "doc" directory +for further documentation. WHAT'S WHAT =========== README -- this file +LICENSE -- The GNU LGPL (Lesser General Public Licence) Makefile -- delegates to tools/htdocs/Makefile +src -- source-code that is compiled into the tools area tools -- the tools that make up the Widget Set examples -- examples of applications that use MKWS - +doc -- documentation (in Markdown, compiles to HTML) +test -- regression-testing scripts notes -- internal documents, not for customers