aboutsummaryrefslogtreecommitdiffstats
path: root/util/generate-hooks-index/README.md
diff options
context:
space:
mode:
authorken restivo <ken@restivo.org>2015-11-03 21:15:49 -0800
committerken restivo <ken@restivo.org>2015-11-03 21:15:49 -0800
commitd9c7b39b884511b38ca339d032f4688b86472af1 (patch)
tree5a17253a8a1c4965ac0bc4d643381a4966e93438 /util/generate-hooks-index/README.md
parent380e3e64cb88c3456e279a9f55a65d5049859159 (diff)
downloadvolse-hubzilla-d9c7b39b884511b38ca339d032f4688b86472af1.tar.gz
volse-hubzilla-d9c7b39b884511b38ca339d032f4688b86472af1.tar.bz2
volse-hubzilla-d9c7b39b884511b38ca339d032f4688b86472af1.zip
Commit the tool used to generate the hooks docs.
Diffstat (limited to 'util/generate-hooks-index/README.md')
-rw-r--r--util/generate-hooks-index/README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/util/generate-hooks-index/README.md b/util/generate-hooks-index/README.md
new file mode 100644
index 000000000..a3d4f7666
--- /dev/null
+++ b/util/generate-hooks-index/README.md
@@ -0,0 +1,30 @@
+# Generate hooks
+
+This program generates hooks.html documentation from the Hubzilla source.
+
+## Usage
+
+Download and install leiningen
+
+Change directory into hubzilla/util/generate-hooks-index
+
+At shell prompt, do:
+
+```sh
+lein run
+```
+
+Hooks docs will get dumped into hubzilla/doc/hooks.html
+
+## Requirements
+
+* JVM like OpenJDK etc
+
+* [Leiningen](http://leiningen.org/)
+
+## License
+
+Copyright © 2015 ken restivo (ken@restivo.org)
+
+Distributed under the Eclipse Public License either version 1.0 or (at
+your option) any later version.