X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=README;h=a0716fca680fb39d9bda33d170984d20b7bc2ffa;hb=ec95c20272197409599daa60edd48298a72312a4;hp=c3996cb97aea8ffd0bacca716c4a035a9c4d2348;hpb=eee7160fffd700c2f4776b2585af1c620b12f99a;p=mkws-moved-to-github.git diff --git a/README b/README index c3996cb..a0716fc 100644 --- a/README +++ b/README @@ -5,28 +5,28 @@ 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 -etc -- configuration files for the various experiments - apache2 -- configuration for running spdemo - service-proxy -- config for running a local Service Proxy +notes -- internal documents, not for customers Required devel tools ==================== -on debian, you will need: curl git-core pandoc +on debian, you will need: +$ sudo apt-get install curl git-core pandoc yui-compressor node-js + +for apache setup, see tools/apache2/README + +NEWS +========= + +see tools/htdocs/NEWS