diff options
author | Tom Willemse | 2014-04-12 13:04:12 +0200 |
---|---|---|
committer | Tom Willemse | 2014-04-12 13:04:12 +0200 |
commit | 7281969e6eaccc5ec8845436dae5b25269558e31 (patch) | |
tree | 44f54c38a98194d00433822a76efd6e3a9cad564 /INSTALL.org | |
parent | 74763c295b5f8cc4f9b5864bb2bba832bc040e74 (diff) | |
download | commit-check-7281969e6eaccc5ec8845436dae5b25269558e31.tar.gz commit-check-7281969e6eaccc5ec8845436dae5b25269558e31.zip |
Add README and INSTALL files
Diffstat (limited to 'INSTALL.org')
-rw-r--r-- | INSTALL.org | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/INSTALL.org b/INSTALL.org new file mode 100644 index 0000000..1b83c5c --- /dev/null +++ b/INSTALL.org @@ -0,0 +1,14 @@ +* commit-check Installation Guide + +** For manual use + + To get this project up and running make sure you have perl + installed and that commit-check is somewhere in your ~PATH~. + +** As git hook + + Place the commit-check executable file in the ~.git/hooks~ directory + of your project, with the name ~commit-msg~. It doesn't need to be + the actual executable, it can also be a (soft) link to the + executable, or a script running this program (passing along all + arguments). |