X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=README;h=88ce97910cce75b680b7e2cc685f759413f9c4bf;hp=6e169138994cf1df8078fe3441da69c8d32ed1fe;hb=aaf2d1298db8915d8359bd64c0dc82c4c1dfb130;hpb=bb5b00d30080c9f6d55d7726e9f5264800d1e61e diff --git a/README b/README index 6e16913..88ce979 100644 --- a/README +++ b/README @@ -1,29 +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 +README -- this file +LICENSE -- The GNU LGPL (Lesser General Public Licence) Makefile -- delegates to tools/htdocs/Makefile -tools -- the tools that make up the Widget Set +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 -notes -- internal documents, not for customers +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 - NEWS -========= +==== see tools/htdocs/NEWS +