From 03a2fcba7b99f2cd56f105a2818d5fd7d1dff8a1 Mon Sep 17 00:00:00 2001 From: Tom Willemse Date: Sat, 12 Apr 2014 13:09:26 +0200 Subject: [PATCH] Remove INSTALL, place everything in README --- INSTALL.org | 14 -------------- README.org | 22 ++++++++++++++++++++++ 2 files changed, 22 insertions(+), 14 deletions(-) delete mode 100644 INSTALL.org diff --git a/INSTALL.org b/INSTALL.org deleted file mode 100644 index 1b83c5c..0000000 --- a/INSTALL.org +++ /dev/null @@ -1,14 +0,0 @@ -* 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). diff --git a/README.org b/README.org index 263164e..0b96875 100644 --- a/README.org +++ b/README.org @@ -1,3 +1,6 @@ +#+STARTUP: showall +#+OPTIONS: toc:nil + * commit-check v0.1.0 This is the commit-check project. It is a quick and easy commit @@ -17,3 +20,22 @@ This project is licensed under the GNU GPLv3, its terms and conditions can be found in [[file:COPYING]]. + +** Installation + + commit-check can either be used manually (or as a back-end to some + other tool), or as a git ~commit-msg~ hook to stop you from + committing badly styled commit messages. + +*** 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).