Merge branch 'contributing' of https://github.com/zetok/ProjectTox-Core

2 files changed, 32 insertions, 11 deletions

diff --git a/other/astyle/README b/other/astyle/README
deleted file mode 100644
index 26802ec7..00000000
--- a/other/astyle/README
+++ /dev/null
@@ -1,11 +0,0 @@
-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
diff --git a/other/astyle/README.md b/other/astyle/README.md
new file mode 100644
index 00000000..f68edf68
--- /dev/null
+++ b/other/astyle/README.md
@@ -0,0 +1,32 @@
+This directory can house various tools and utilities.
+
+# How to use astyle
+
+## Manually
+
+### For all files
+
+Run from ``toxcore`` directory:
+```bash
+astyle --options=./other/astyle/astylerc ./toxcore/*.c ./toxcore/*.h ./toxdns/*.c ./toxdns/*.h ./testing/*.c ./toxav/*.c ./toxav/*.h ./other/*.c ./other/bootstrap_daemon/*.c ./toxencryptsave/*.c ./toxencryptsave/*.h ./auto_tests/*.c
+```
+
+### For selected file
+
+Run from ``toxcore`` directory, e.g. for [``tox.h``](/toxcore/tox.h) file:
+```bash
+astyle --options=./other/astyle/astylerc ./toxcore/tox.h
+```
+
+
+## Automatically, as pre-commit hook (*NIX only)
+
+Copy [``astylerc``](/other/astyle/astylerc) to ``toxcore/.git/hooks``
+
+
+
+# Why
+
+``astylerc`` - this file can be used in the pre-commit hook to try its best at making the code conform to the coding style of toxcore.
+
+Furthermore, it is being used to format ``tox.h`` after using [``apidsl``](/other/apidsl) to generate it.
\ No newline at end of file