summaryrefslogtreecommitdiff
path: root/tools/README
diff options
context:
space:
mode:
Diffstat (limited to 'tools/README')
-rw-r--r--tools/README9
1 files changed, 9 insertions, 0 deletions
diff --git a/tools/README b/tools/README
new file mode 100644
index 00000000..4d8538c3
--- /dev/null
+++ b/tools/README
@@ -0,0 +1,9 @@
1This directory can house various tools and utilities.
2
3astylerc
4 - This file can be used in the precommit hook to try its best at making the code conform to the coding style document.
5
6pre-commit (*NIX only at the moment)
7 - Lints your file in adherence to the coding style doucment as best as possible in terms of spacing, indenting, etc.
8 - Requires you to have astyle installed.
9 - To use, copy this file to ProjectTox-Core/.git/hooks