Changes in this version (v2.2.1):
- maturity stable.
- added plugin icon.
- fixed copy/paste typo @ version.php.
- accept inline comments starting by digit (Tim Hunt).
- improve line length check on non-php files (Tim Hunt).

This Moodle plugin uses the Pear CodeSniffer library to check that code follows
the Moodle coding guidelines http://docs.moodle.org/en/Development:Coding_style

It was created by developers at the Open University, including Sam Marshall,
Tim Hunt and Jenny Gray. It is now maintained by Moodle HQ

To install using git, type this command in the root of your Moodle install
git clone git://github.com/moodlehq/moodle-local_codechecker.git local/codechecker
Then add /local/codechecker to your git ignore.

Alternatively, download the zip from
https://github.com/moodlehq/moodle-local_codechecker/zipball/master
unzip it into the local folder, and then rename the new folder to codechecker.

After you have installed this local plugin , you should see a new option
Site administration -> Development -> Code checker in the settings block.

We hope you find this tool useful. Please feel free to enhance it.


Tip for Eclipse users:

If if you use Eclipse for development, you might want to install the
PHP CodeSniffer plugin (http://www.phpsrc.org/).
1. Create a new "CodeSniffer standard" in the preferences page.
2. Point it at the moodle directory inside the codechecker folder.
3. Thank Michael Aherne from University of Strathclyde who worked this out!