From 5806f20625c2a275027ec8a2134b7e0c91e4d158 Mon Sep 17 00:00:00 2001 From: Steven McCullagh Date: Mon, 25 Nov 2019 10:49:12 +0000 Subject: [PATCH] Update README.txt with details of how to install and use on command line. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 5b68b45d..4eb5252f 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,8 @@ To install it using git, type this command in the root of your Moodle install: Then add /local/codechecker to your git ignore. +Additionally, remember to only use the version of PHPCS located in ``pear/PHP/scripts/phpcs`` rather than installing PHPCS directly. Add the location of the PHPCS executable to your system path, tell PHPCS about the Moodle coding standard with ``phpcs --config-set installed_paths /path/to/moodle-local_codechecker`` and set the default coding standard to Moodle with ``phpcs --config-set default_standard moodle``. You can now test a file (or folder) with: ``phpcs /path/to/file.php``. + Alternatively, download the zip from , unzip it into the local folder, and then rename the new folder to "codechecker".