Skip to content

Commit

Permalink
Update README.txt with details of how to install and use on command l…
Browse files Browse the repository at this point in the history
…ine.
  • Loading branch information
Steven McCullagh committed Nov 25, 2019
1 parent cd57373 commit 5806f20
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://github.com/moodlehq/moodle-local_codechecker/zipball/master>,
unzip it into the local folder, and then rename the new folder to "codechecker".
Expand Down

0 comments on commit 5806f20

Please sign in to comment.