c3996cb97aea8ffd0bacca716c4a035a9c4d2348
[mkws-moved-to-github.git] / README
1 OVERVIEW
2 ========
3
4 The MasterKey Widget Set, or MKWS, is a project to create some very
5 simple HTML/JS/CSS widgets that can be dropped into ANY website,
6 irrespective of CMS or lack thereof, to enable MasterKey searching.
7
8 The top level bug for discussing this is
9         https://jira.indexdata.com/browse/MKWS-1
10 and a high-level description can be found at
11         https://twiki.indexdata.com/twiki/bin/view/ID/MasterKeyWidgetSet
12
13
14 WHAT'S WHAT
15 ===========
16
17 experiments -- a directory containing code experiments:
18         jquery-ui -- Using a JQuery UI element
19         jsdemo -- The basic pazpar2 client, running locally
20         spclient -- Mike's hardly-there sketch
21         spdemo -- Wolfram's functioning jsdemo-targeted-at-SP
22
23 etc -- configuration files for the various experiments
24         apache2 -- configuration for running spdemo
25         service-proxy -- config for running a local Service Proxy
26
27
28 Required devel tools
29 ====================
30
31 on debian, you will need: curl git-core pandoc
32