From d9c7b39b884511b38ca339d032f4688b86472af1 Mon Sep 17 00:00:00 2001 From: ken restivo Date: Tue, 3 Nov 2015 21:15:49 -0800 Subject: Commit the tool used to generate the hooks docs. --- util/generate-hooks-index/README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 util/generate-hooks-index/README.md (limited to 'util/generate-hooks-index/README.md') 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. -- cgit v1.2.3