X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=README;h=7aacc48b0ef57af4397bfa263968f47727bc3df2;hp=2d702a4268806564edca21eca9bde4240eeb9e90;hb=0fc946af7aee27a0180ae240938c78243cafe05f;hpb=f18d4ea782b37d8a56636f759ab0982bc6a5830f diff --git a/README b/README index 2d702a4..7aacc48 100644 --- a/README +++ b/README @@ -5,27 +5,37 @@ 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: -$ sudo apt-get install curl git-core pandoc yui-compressor +On debian, you will need: +$ sudo apt-get install curl git-core pandoc yui-compressor node-js libbsd-resource-perl + +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. + +To compile the default templates you'll need to install the stable version +of Handlebars. Currently it's at 1.3.0 and available by npm: + + npm install handlebars@1.3.0 -g + +For apache setup, see tools/apache2/README NEWS =========