X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=README;h=a0716fca680fb39d9bda33d170984d20b7bc2ffa;hb=9d8bf7e27c93d61482c3ea113bb211de1db10d6b;hp=3b99f6182cad86906c699f38ebdde0c71b19d91a;hpb=e02e942ecf467457eb8221d124dfd7d795d3d815;p=mkws-moved-to-github.git diff --git a/README b/README index 3b99f61..a0716fc 100644 --- a/README +++ b/README @@ -5,24 +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 =========== -README -- this file +README -- this file Makefile -- delegates to tools/htdocs/Makefile -tools -- the tools that make up the Widget Set +tools -- the tools that make up the Widget Set examples -- examples of applications that use MKWS -notes -- internal documents, not for customers + +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