summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
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.
+
+