X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=README;h=98645e522786fad4fa0c89f690fda089484502ef;hp=96bd7ef3ee421b5c7fed0133235fcfe9d2c80867;hb=93467cfec69ee4bfa6335595bc23e218482f3dbc;hpb=f774dad47ebce13e0bd13a461ce1765d1b7d0f96 diff --git a/README b/README index 96bd7ef..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,33 +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 -==================== - -If you are building the widget set, as opposed to just using it, you -will need the following Debian packages (or their equivalents on your -operating system): - -$ sudo apt-get install curl git pandoc yui-compressor libbsd-resource-perl - -You also need Node.js, but unfortunately the node-js package is not -available for Debian wheezy. You can either get it from -wheezy-backports or download the source from -http://nodejs.org/download/ and build it yourself. You need node and -npm, its package manager: 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 2.0.0 and available by npm: - - npm install handlebars@2.0.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