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
CHange heading
[mkws-moved-to-github.git]
/
README
diff --git
a/README
b/README
index
3b99f61
..
a0716fc
100644
(file)
--- a/
README
+++ b/
README
@@
-5,24
+5,28
@@
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.
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
-
WHAT'S WHAT
===========
WHAT'S WHAT
===========
-README -- this file
+README -- this file
Makefile -- delegates to tools/htdocs/Makefile
Makefile -- delegates to tools/htdocs/Makefile
-tools -- the tools that make up the Widget Set
+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
+
+notes -- internal documents, not for customers
Required devel tools
====================
Required devel tools
====================
-on debian, you will need: curl git-core pandoc
+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