toxcore/tools/README

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
core,nTox,toxic - Fix for Issue #453. Refactoring w/astyle. This commit introduces a few things. Basically I didn't like the fact that although we had a coding style document, no one was following it. See https://github.com/irungentoo/ProjectTox-Core/issues/453 for more info regarding that. This commit just marks the first of my efforts to refactor the code base according to the posted coding style document by introducing an astylerc and a optional git pre-commit hook. I propose that users can add this functionality as a pre-commit hook. More info is in the README file. However, this has only been tested on Linux and I imagine should work on OSX as well. I don't think pre-commit hooks work on Windows, but I may be mistaken. The future commits I plan are refactoring the source files for other offending items such as using typedefs. See http://wiki.tox.im/index.php/Coding_Style. 2013-08-15 10:03:28 +08:00			`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`