#+STARTUP: showall
#+OPTIONS: toc:nil

* commit-check v0.1.0

  This is the commit-check project. It is a quick and easy commit
  style checker that can be used either as a git hook to enforce the
  style checked by commit-check, or as a syntax checker back-end (like
  [[http://flycheck.readthedocs.org/en/latest/][Flycheck]]).

  The file [[file:INSTALL.org]] contains instructions on how to install
  commit-check on your system.

  The entire code for the project is currently contained in the
  [[file:commit-check]] file. The files [[file:test-pass.txt]],
  [[file:test-fail-barely.txt]] and [[file:test-fail-miserably.txt]] are used
  for testing purposes. They contain and explain certain situations
  that can occur when writing commits that may or may not cause errors
  to be reported.

  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).