X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=README;h=98645e522786fad4fa0c89f690fda089484502ef;hp=927ee560ace46e622712036b67fbc2bbed366efe;hb=c585a57088f515500bae115377d84c57fbb3765f;hpb=fbe7e5cb7b0f61e16242f4f71ef417d454a09c33 diff --git a/README b/README index 927ee56..98645e5 100644 --- a/README +++ b/README @@ -1,14 +1,6 @@ -OVERVIEW -======== - 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. See the contents of the "doc" directory -for further documentation. - - -WHAT'S WHAT -=========== +to enable MasterKey searching. README -- this file LICENSE -- The GNU LGPL (Lesser General Public Licence) @@ -20,29 +12,10 @@ doc -- documentation (in Markdown, compiles to HTML) test -- regression-testing scripts notes -- internal documents, not for customers +See tools/htdocs/NEWS for the change-log. -Required devel tools -==================== - -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 -========= - -see tools/htdocs/NEWS +For more documentation: +doc/index.markdown -- overview +doc/mkws-manual.markdown -- how to use the widget set +doc/mkws-developer.markdown -- how to develop and customise widgets