X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=README;h=6e169138994cf1df8078fe3441da69c8d32ed1fe;hp=370c54ebf8e18b60a8785bda3939c01951ba3ac4;hb=12e9a050f7d661b1f15725b3aab709222ea35987;hpb=3360a31122525a9e7c0a32e3e93e1db34a777d73 diff --git a/README b/README index 370c54e..6e16913 100644 --- a/README +++ b/README @@ -5,22 +5,25 @@ 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 +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: +$ sudo apt-get install curl git-core pandoc yui-compressor + +NEWS +========= -etc -- configuration files for the various experiments - apache2 -- configuration for running spdemo - service-proxy -- config for running a local Service Proxy +see tools/htdocs/NEWS