aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README22
1 files changed, 11 insertions, 11 deletions
diff --git a/README b/README
index beb2737..821a833 100644
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
git-hooks - A tool to manage Git hooks for multiple git repositories.
-Hooks can be very powerful and useful. Some hooks that can be found include:
+Hooks can be very powerful and useful. Some common hooks include:
- Spell check the commit message.
- Check that the code builds.
@@ -8,21 +8,21 @@ Hooks can be very powerful and useful. Some hooks that can be found include:
Hooks can also be very project specific such as:
-- Verify that any new code follows the coding style (this is always different)
+- Pre-populate the commit message with the 'standard' format.
+- Verify that any new code follows the 'standard' coding style.
-or very people specific such as:
+or very specific to one person such as:
-- Don't allow me to push after 1am in case I break something.
-- Don't let me commit between 9-5 for projects in ~/personal/ as I shouldn't be working on them.
+- Don't allow a push to a remote repository after 1am in case I break something and will be asleep.
+- Don't let me commit between 9-5 for projects in ~/personal/ as I shouldn't be working on them during work hours.
git-hooks provide a way to manage and share your hooks by allowing for the installation of hooks in three locations:
- User hooks that are installed in ~/.git_hooks/
- - Project hooks that are installed in the git_hooks directory of each project
+ - Project hooks that are installed in the git_hooks directory inside of each project.
- Global hooks that are specified with the environment variable GLOBAL_GIT_HOOKS.
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.
-
+Multiple global hooks directories can be specified by using a space between each path.
--- Creating hooks
@@ -30,10 +30,10 @@ To keep things organized git-hooks looks for scripts in sub directories named af
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.
+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. Checkout the hooks in contrib for some examples.
-- Install
-Clone the git-hooks repository and add it to your path.
+Clone the git-hooks repository and add the directory to your PATH environment variable so git-hooks will be detected.
-Inside a project's directory run 'git hooks --install' to change that projects git hooks (which defaults to doing nothing) to use git-hooks hooks.
+Inside a project's directory run 'git hooks --install' to change that projects git hooks to use git-hooks hooks. 'git hooks --uninstall' can be run at any time to go back to the old hooks that were installed before (usually the default which does nothing).