Skip to content

Commit e4457f0

Browse files
author
Akiha Senda
committed
Update README.md
1 parent b443e0a commit e4457f0

1 file changed

Lines changed: 38 additions & 24 deletions

File tree

README.md

Lines changed: 38 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,68 @@
1-
flymake-phpcs.el
2-
================
1+
# Note
2+
3+
##### I recommend that you use the [flycheck](https://github.com/flycheck/flycheck).
4+
5+
##### Because, you can run the checker more than one. Of course, including `phpcs`.
6+
7+
# flymake-phpcs.el
38

49
PHP CodeSniffer for Emacs with flymake-mode.
510

611
To use [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) with Emacs, you will need PHP CodeSniffer installed.
712

813
You should be able to run
914

10-
$ phpcs
15+
```sh
16+
$ phpcs
17+
```
1118

1219
and, you'll also need to install [flymake-easy](https://github.com/purcell/flymake-easy).
1320

14-
Usage
15-
=====
21+
# Usage
1622

1723
You'll need to add the directory containing `flymake-phpcs.el` to your `load-path`.
1824

1925
If not, also add to your config
2026

21-
(add-to-list 'load-path "~/.emacs.d/path/to/flymake-phpcs.el")
27+
```lisp
28+
(add-to-list 'load-path "~/.emacs.d/path/to/flymake-phpcs.el")
29+
```
2230

23-
Add to your Emacs config
24-
------------------------
31+
## Add to your Emacs config
2532

26-
(require 'flymake-phpcs)
27-
(add-hook 'php-mode-hook 'flymake-phpcs-load)
33+
```lisp
34+
(require 'flymake-phpcs)
35+
(add-hook 'php-mode-hook 'flymake-phpcs-load)
36+
```
2837

29-
How to customize the Coding Standard
30-
------------------------------------
38+
## How to customize the Coding Standard
3139

32-
(custom-set-variables
33-
'(flymake-phpcs-standard "PSR2"))
40+
```lisp
41+
(custom-set-variables
42+
'(flymake-phpcs-standard "PSR2"))
43+
```
3444

3545
or
3646

37-
(custom-set-variables
38-
'(flymake-phpcs-standard "/path/to/MyStandard"))
47+
```lisp
48+
(custom-set-variables
49+
'(flymake-phpcs-standard "/path/to/MyStandard"))
50+
```
3951

40-
phpcs command location
41-
----------------------
52+
## phpcs command location
4253

4354
By default, the location of the `phpcs` command is searched.
4455

45-
(custom-set-variables
46-
'(flymake-phpcs-command "/path/to/phpcs"))
56+
```lisp
57+
(custom-set-variables
58+
'(flymake-phpcs-command "/path/to/phpcs"))
59+
```
4760

48-
Where to create temporary copy
49-
------------------------------
61+
## Where to create temporary copy
5062

5163
one of 'tempdir or 'inplace (default).
5264

53-
(custom-set-variables
54-
'(flymake-phpcs-location 'tempdir))
65+
```lisp
66+
(custom-set-variables
67+
'(flymake-phpcs-location 'tempdir))
68+
```

0 commit comments

Comments
 (0)