X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=README;h=3144b20785c8655a592f3023684a13c9804a2ac6;hb=b223f1236d9f125aa43db80eee372ef1b31fc723;hp=2d702a4268806564edca21eca9bde4240eeb9e90;hpb=f18d4ea782b37d8a56636f759ab0982bc6a5830f;p=mkws-moved-to-github.git diff --git a/README b/README index 2d702a4..3144b20 100644 --- a/README +++ b/README @@ -1,31 +1,41 @@ OVERVIEW ======== -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 +The MasterKey Widget Set, or MKWS, provides HTML/JS/CSS widgets that +can be dropped into ANY website, irrespective of CMS or lack thereof, +to enable MasterKey searching. 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 =========