X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=README;h=f5e47844a22047ffbe2c07d34a01ddbc0f4ea396;hb=19feeb08f8f00ee6c4fc3ae32570902a342dd20a;hp=5b6a98b4a9535af989053cb35fd5603f44d89e9e;hpb=4f4020ed0de121934f9118d533c5ab9b3ecaa79e;p=mkws-moved-to-github.git diff --git a/README b/README index 5b6a98b..f5e4784 100644 --- a/README +++ b/README @@ -1,15 +1,8 @@ -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 -=========== - README -- this file LICENSE -- The GNU LGPL (Lesser General Public Licence) Makefile -- delegates to tools/htdocs/Makefile @@ -20,31 +13,4 @@ doc -- documentation (in Markdown, compiles to HTML) test -- regression-testing scripts notes -- internal documents, not for customers - -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. 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 - - +See tools/htdocs/NEWS for the change-log.