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