From c45000453c661a82c046a6fa7bf8d1b70206f89f Mon Sep 17 00:00:00 2001 From: Benjamin C Meyer Date: Wed, 17 Mar 2010 01:05:56 -0400 Subject: Add a section to the README describing how to create hooks Signed-off-by: Benjamin C Meyer --- README | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README b/README index 2190287..beb2737 100644 --- a/README +++ b/README @@ -23,6 +23,15 @@ git-hooks provide a way to manage and share your hooks by allowing for the insta When GLOBAL_GIT_HOOKS is not set it defaults to the git-hooks /contrib/ folder. Multiple global hooks directories can be specified by using a space between them. + +--- Creating hooks + +To keep things organized git-hooks looks for scripts in sub directories named after the git hook name. For example this project has the following pre-commit script in the following location: + +git_hooks/pre-commit/bsd + +When you run 'git hooks' with no arguments it will list all of the hooks installed on the system. It will run the hooks with the --about argument to generate the description that is shown. + -- Install Clone the git-hooks repository and add it to your path. -- cgit v1.2.3