No need for a separate NEWS section.
[mkws-moved-to-github.git] / README
1 OVERVIEW
2 ========
3
4 The MasterKey Widget Set, or MKWS, provides HTML/JS/CSS widgets that
5 can be dropped into ANY website, irrespective of CMS or lack thereof,
6 to enable MasterKey searching. See the contents of the "doc" directory
7 for further documentation.
8
9
10 WHAT'S WHAT
11 ===========
12
13 README   -- this file
14 LICENSE  -- The GNU LGPL (Lesser General Public Licence)
15 Makefile -- delegates to tools/htdocs/Makefile
16 src      -- source-code that is compiled into the tools area
17 tools    -- the tools that make up the Widget Set
18 examples -- examples of applications that use MKWS
19 doc      -- documentation (in Markdown, compiles to HTML)
20 test     -- regression-testing scripts
21 notes    -- internal documents, not for customers
22
23 See tools/htdocs/NEWS for the change-log.
24
25