summaryrefslogtreecommitdiff
path: root/tools/README
diff options
context:
space:
mode:
authorirungentoo <irungentoo@gmail.com>2013-08-15 16:58:27 -0700
committerirungentoo <irungentoo@gmail.com>2013-08-15 16:58:27 -0700
commit0a00c5c29143b2613a512c5ff3f5f6c1e390f1ac (patch)
tree8b0a059cf26481bcfdcf00ba41707787a8ee42b0 /tools/README
parent75873e31db5a881cdd0caf408c192e91b1901149 (diff)
parentd0098efa958ca82dc9c65c93b5830d727422faef (diff)
Merge pull request #457 from aaboagye/master
core,nTox,toxic - Fix for Issue #453. Begin refactoring w/astyle.
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