From 692748a07684cf6caf67fa736db853781c58842f Mon Sep 17 00:00:00 2001
From: Christian Klinger
Date: Thu, 29 Sep 2016 15:48:49 +0200
Subject: added a pre-commit hook for astyle.

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index c1bba45..96ee734 100644
--- a/README.md
+++ b/README.md
@@ -82,3 +82,25 @@ something like "xscreensaver-command --lock" or similar.
 
 ### Network Setup
 
+
+
+# FOR CONTRIBUTORS
+
+## Code Style
+Please check the file `.astylerc` for details. We recommend to install a
+pre-commit hook to make sure that one only commit complying code. Such a hook
+can be found in scripts/astyle-check.sh
+
+Steps to install the hook:
+  # install `astyle`
+  apt-get install astyle
+
+  cd pvs2
+  cd .git/hooks
+  ln -s ../../scripts/astyle-check.sh pre-commit
+  chmod +x pre-commit
+
+If a staged file does not comply to our coding style, you can use
+ `astyle --options=./.astylerc <FILE>` to correct the style.
+
+
-- 
cgit v1.2.3-55-g7522