Ignore vim swap files.

[mkws-moved-to-github.git] / README

diff --git a/README b/README
index 370c54e..55d911c 100644 (file)
--- a/README
+++ b/README
@@ -5,22 +5,35 @@ 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 node-js
+
+On Debian 7 (wheezy), you do not need git-core, plain git will do, but
+you probably have that on a development box already. Unfortunately, node-js
+is not available for wheezy. Either you can get it from wheezy-backports,
+or you can download the source from http://nodejs.org/download/ and build
+it yourself. Looks like you need node and npm, make install puts them
+into /usr/local/bin.
+
+For apache setup, see tools/apache2/README
+
+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