X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=README;h=88ce97910cce75b680b7e2cc685f759413f9c4bf;hp=5696cd17a5c160b64ccdbc73570af784b6286409;hb=aaf2d1298db8915d8359bd64c0dc82c4c1dfb130;hpb=2ee3ba92026dd19222b9e8c36b6a5d2348c950d9 diff --git a/README b/README index 5696cd1..88ce979 100644 --- a/README +++ b/README @@ -1,39 +1,29 @@ 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 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 +src -- source-code that is compiled into the tools area tools -- the tools that make up the Widget Set examples -- examples of applications that use MKWS - +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. Looks like you need node and npm, make install puts them -into /usr/local/bin. - -For apache setup, see tools/apache2/README - NEWS -========= +==== see tools/htdocs/NEWS +