Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add installation instructions to the README.

  • Loading branch information...
commit af7ef114fafd778dfffdfb01a830265f3c71a2e9 1 parent c52b400
@bmeurer authored
Showing with 50 additions and 0 deletions.
  1. +50 −0 README
View
50 README
@@ -5,3 +5,53 @@ Git Hooks provides a simple mechanism to manage hooks for several Git
repositories in a unified and simple way. It allows you to install hook
scripts in a central location and use them for your Git repositories.
+
+Installation
+
+You need CMake and GCC in order to build and install git-hooks. You will
+also need to have Git and Perl installed for the hooks to work properly.
+To build git-hooks run
+
+ $ cmake /path/to/git-hooks
+ $ make
+
+in a new directory (preferably, tho you may also run it from the source
+directory). Then, use
+
+ $ make install
+
+to install git-hooks. This will install git-hooks to /usr/local. You can
+use ccmake to change the installation prefix. Below, we will assume that
+you installed git-hooks to /usr/local.
+
+
+Repository setup
+
+To setup a repository using git-hooks, just use the repository template
+that ships with git-hooks.
+
+ $ mkdir myrepo.git
+ $ cd myrepo.git
+ $ git --bare init --template=/usr/local/share/git-hooks/template ...
+
+This will setup the new repository myrepo.git with git-hooks. Check the
+sample config file that will be created for myrepo.git.
+
+
+Repository migration
+
+To migrate an existing repository to use git-hooks, you should first backup
+your existing hook scripts. Then replace the hooks with the ones from
+/usr/local/share/git-hooks/template/hooks. Afterwards, you should migrate
+your previous hook scripts to global hook scripts used by git-hooks.
+
+
+Configuration
+
+The git-hooks package includes several useful hooks, which can be configured
+to your needs using git config settings in your repository (or even global
+settings from /etc/gitconfig). The /usr/local/share/git-hooks/template/config
+file provides a sample configuration file.
+
+Please see the hook scripts in /usr/local/share/git-hooks/*.d/ for the
+various supported config settings.
Please sign in to comment.
Something went wrong with that request. Please try again.