diff options
| author | Benjamin C Meyer <ben@meyerhome.net> | 2010-03-17 01:05:56 -0400 |
|---|---|---|
| committer | Benjamin C Meyer <ben@meyerhome.net> | 2010-03-17 02:18:38 -0400 |
| commit | c45000453c661a82c046a6fa7bf8d1b70206f89f (patch) | |
| tree | cd4a3785849bef7594b73d1157332de536ec329f | |
| parent | 8a3487ce99580bac295ca1bc1e5e13ede49cb22c (diff) | |
| download | git-hooks-c45000453c661a82c046a6fa7bf8d1b70206f89f.tar.gz git-hooks-c45000453c661a82c046a6fa7bf8d1b70206f89f.tar.bz2 | |
Add a section to the README describing how to create hooks
Signed-off-by: Benjamin C Meyer <ben@meyerhome.net>
| -rw-r--r-- | README | 9 |
1 files changed, 9 insertions, 0 deletions
@@ -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. |