X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=README;h=f5e47844a22047ffbe2c07d34a01ddbc0f4ea396;hb=19feeb08f8f00ee6c4fc3ae32570902a342dd20a;hp=a0716fca680fb39d9bda33d170984d20b7bc2ffa;hpb=9d8bf7e27c93d61482c3ea113bb211de1db10d6b;p=mkws-moved-to-github.git diff --git a/README b/README index a0716fc..f5e4784 100644 --- a/README +++ b/README @@ -1,32 +1,16 @@ -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. - - -WHAT'S WHAT -=========== +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. 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 - -for apache setup, see tools/apache2/README - -NEWS -========= - -see tools/htdocs/NEWS - +See tools/htdocs/NEWS for the change-log.