projects
/
mkws-moved-to-github.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Remove all headings from the README.
[mkws-moved-to-github.git]
/
README
diff --git
a/README
b/README
index
6e16913
..
f5e4784
100644
(file)
--- a/
README
+++ b/
README
@@
-1,29
+1,16
@@
-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.
-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
-===========
-
-README -- this file
+README -- this file
+LICENSE -- The GNU LGPL (Lesser General Public Licence)
Makefile -- delegates to tools/htdocs/Makefile
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
examples -- examples of applications that use MKWS
-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
+doc -- documentation (in Markdown, compiles to HTML)
+test -- regression-testing scripts
+notes -- internal documents, not for customers
+See tools/htdocs/NEWS for the change-log.