aboutsummaryrefslogtreecommitdiffstats
path: root/util/generate-hooks-index/README.md
diff options
context:
space:
mode:
authorWave <wave72@users.noreply.github.com>2015-11-06 09:09:58 +0100
committerWave <wave72@users.noreply.github.com>2015-11-06 09:09:58 +0100
commit30d083ac3cbdf36171cfee7b892271b9b587325c (patch)
treef2f63728f86f8336330d31ee8edf2fcd742dc71e /util/generate-hooks-index/README.md
parent50cf095c000813d0b1408d929c1fa7422b131a3d (diff)
parent4ca0c2cfd14df5e2b6e9c7f59a10628f7653d6a4 (diff)
downloadvolse-hubzilla-30d083ac3cbdf36171cfee7b892271b9b587325c.tar.gz
volse-hubzilla-30d083ac3cbdf36171cfee7b892271b9b587325c.tar.bz2
volse-hubzilla-30d083ac3cbdf36171cfee7b892271b9b587325c.zip
Merge pull request #2 from redmatrix/master
Update to latest hubzilla
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.