X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=README;h=f5e47844a22047ffbe2c07d34a01ddbc0f4ea396;hb=19feeb08f8f00ee6c4fc3ae32570902a342dd20a;hp=370c54ebf8e18b60a8785bda3939c01951ba3ac4;hpb=3360a31122525a9e7c0a32e3e93e1db34a777d73;p=mkws-moved-to-github.git diff --git a/README b/README index 370c54e..f5e4784 100644 --- a/README +++ b/README @@ -1,26 +1,16 @@ -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. See the contents of the "doc" directory +for further documentation. -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. - -The top level bug for discussing this is - https://jira.indexdata.com/browse/MKWS-1 -and a high-level description can be found at - https://twiki.indexdata.com/twiki/bin/view/ID/MasterKeyWidgetSet - - -WHAT'S WHAT -=========== - -experiments -- a directory containing code experiments: - jquery-ui -- Using a JQuery UI element - jsdemo -- The basic pazpar2 client, running locally - spclient -- Mike's hardly-there sketch - spdemo -- Wolfram's functioning jsdemo-targeted-at-SP - -etc -- configuration files for the various experiments - apache2 -- configuration for running spdemo - service-proxy -- config for running a local Service Proxy +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 +See tools/htdocs/NEWS for the change-log.