Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
braver committed Apr 2, 2018
1 parent 5dc0f56 commit 6f4d1a5
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,18 @@ SublimeLinter-phpmd

[![Build Status](https://travis-ci.org/SublimeLinter/SublimeLinter-phpmd.svg?branch=master)](https://travis-ci.org/SublimeLinter/SublimeLinter-phpmd)

This linter plugin for [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) provides an interface to [phpmd](http://phpmd.org/documentation/index.html). It will be used with files that have the “PHP”, “HTML” and “HTML5” syntax.
This linter plugin for [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) provides an interface to [phpmd](http://phpmd.org/documentation/index.html).
It will be used with files that have the "PHP", "HTML" and "HTML5" syntax.


## Installation

SublimeLinter must be installed in order to use this plugin.

Please use [Package Control](https://packagecontrol.io) to install the linter plugin.

Before installing this plugin, you must ensure that `phpmd` is installed on your system. To install `phpmd`, do the following:
Before installing this plugin, ensure that `phpmd` is installed on your system.
To install `phpmd`, do the following:

1. Install [php](http://php.net).

Expand All @@ -23,7 +27,8 @@ Before installing this plugin, you must ensure that `phpmd` is installed on your
pear install --alldeps phpmd/PHP_PMD
```

#### Alternative installation using [composer](https://getcomposer.org/):
### Alternative installation using [composer](https://getcomposer.org/):

1. Install [composer](https://getcomposer.org/).
2. Install `phpmd` using below command:
```
Expand All @@ -34,7 +39,9 @@ composer global require phpmd/phpmd
export PATH=~/.composer/vendor/bin:$PATH
```


## Settings

- SublimeLinter settings: http://sublimelinter.com/en/latest/settings.html
- Linter settings: http://sublimelinter.com/en/latest/linter_settings.html

Expand Down

0 comments on commit 6f4d1a5

Please sign in to comment.