X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=README;h=c867eb6b4a9be08e5da51d0a8df797f705420adb;hp=ba3aaa8249ad7b32a8bf7df064192f6e4674261d;hb=bee77387bc30ca0bf186f05a95852a94e617567e;hpb=af59afe80f26d336200df63ebe4b5fc6d781047a diff --git a/README b/README index ba3aaa8..c867eb6 100644 --- a/README +++ b/README @@ -1,28 +1,25 @@ 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 top level bug for discussing this is - https://jira.indexdata.com/browse/MKWS-1 -and a high-level description can be found at - https://twiki.indexdata.com/twiki/bin/view/ID/MasterKeyWidgetSet +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 -==================== +See tools/htdocs/NEWS for the change-log. -on debian, you will need: curl git-core pandoc yui-compressor