aboutsummaryrefslogtreecommitdiffstats
path: root/util/generate-hooks-index/README.md
diff options
context:
space:
mode:
authormrjive <mrjive@mrjive.it>2015-11-11 16:51:48 +0100
committermrjive <mrjive@mrjive.it>2015-11-11 16:51:48 +0100
commit53a796afcc0cff6f9e3f51457df4506a43db1945 (patch)
treea2366c48e0dae047b052283cc44284224369c8cd /util/generate-hooks-index/README.md
parenta4c3058f845a1c38d06b2201a10700c5f878366d (diff)
parentbc7c0ed844711e81c4bc642e3024849195a48421 (diff)
downloadvolse-hubzilla-53a796afcc0cff6f9e3f51457df4506a43db1945.tar.gz
volse-hubzilla-53a796afcc0cff6f9e3f51457df4506a43db1945.tar.bz2
volse-hubzilla-53a796afcc0cff6f9e3f51457df4506a43db1945.zip
Merge pull request #8 from redmatrix/master
get fresh code from HZ base
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.