update copyright year
[mkws-moved-to-github.git] / README
1 The MasterKey Widget Set, or MKWS, provides HTML/JS/CSS widgets that
2 can be dropped into ANY website, irrespective of CMS or lack thereof,
3 to enable MasterKey searching.
4
5 README   -- this file
6 LICENSE  -- The GNU LGPL (Lesser General Public Licence)
7 Makefile -- delegates to tools/htdocs/Makefile
8 src      -- source-code that is compiled into the tools area
9 tools    -- the tools that make up the Widget Set
10 examples -- examples of applications that use MKWS
11 doc      -- documentation (in Markdown, compiles to HTML)
12 test     -- regression-testing scripts
13 notes    -- internal documents, not for customers
14
15 See tools/htdocs/NEWS for the change-log.
16
17 For more documentation:
18
19 doc/index.markdown -- overview
20 doc/mkws-manual.markdown -- how to use the widget set
21 doc/mkws-developer.markdown -- how to develop and customise widgets