Commits

markant committed e72f0c7

Added simple README file

Comments (0)

Files changed (1)

+About
+------------
+2 hooks included: PEP8 and optipng
+PEP8 will run the pep8 validator against files pending commit
+optipng will optimize any PNG, BMP, GIF, PNM or TIFF images.
+
+Installation
+------------
+Clone a copy of the code and place the hghooks directory somewhere on your
+python path.
+
+In order to use the optipng hook you will need to install optipng on your system
+
+Usage
+------------
+In ~/.hgrc or /path/to/your/project/.hg/hgrc
+
+[hooks]
+precommit.pep8 = python:hghooks.pep8.hook
+precommit.optipng = python:hghooks.optipng.hook