Skip to content

Commit b443e0a

Browse files
author
senda-akiha
committed
update README
1 parent 2b84f4b commit b443e0a

2 files changed

Lines changed: 21 additions & 43 deletions

File tree

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ flymake-phpcs.el
33

44
PHP CodeSniffer for Emacs with flymake-mode.
55

6-
To use [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) with Emacs, you will need PHP CodeSniffer installed and available on your path.
6+
To use [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) with Emacs, you will need PHP CodeSniffer installed.
77

88
You should be able to run
99

@@ -36,3 +36,19 @@ or
3636

3737
(custom-set-variables
3838
'(flymake-phpcs-standard "/path/to/MyStandard"))
39+
40+
phpcs command location
41+
----------------------
42+
43+
By default, the location of the `phpcs` command is searched.
44+
45+
(custom-set-variables
46+
'(flymake-phpcs-command "/path/to/phpcs"))
47+
48+
Where to create temporary copy
49+
------------------------------
50+
51+
one of 'tempdir or 'inplace (default).
52+
53+
(custom-set-variables
54+
'(flymake-phpcs-location 'tempdir))

flymake-phpcs.el

Lines changed: 4 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
;; Author: Akiha Senda <senda.akiha@gmail.com>
66
;; URL: https://github.com/senda-akiha/flymake-phpcs/
77
;; Created: 28 Novenver 2013
8-
;; Version: 20131128.1109
8+
;; Version: 20140112.1211
99
;; Keywords: flymake, phpcs, php
1010
;; Package-Requires: ((flymake-easy "0.9"))
1111

@@ -29,47 +29,9 @@
2929

3030
;;; Commentary:
3131

32-
;; To use PHP CodeSniffer with Emacs, you will need PHP CodeSniffer installed
33-
;; and available on your path. You should be able to do
34-
35-
;; $ phpcs
36-
37-
;; and, you'll also need to install flymake-easy.
38-
39-
;;; Usage
40-
41-
;; Add to your Emacs config:
42-
43-
;; (require 'flymake-phpcs)
44-
;; (add-hook 'php-mode-hook 'flymake-phpcs-load)
45-
46-
;; How to customize the Coding Standard:
47-
48-
;; (custom-set-variables
49-
;; '(flymake-phpcs-standard "PSR2"))
50-
51-
;; or
52-
53-
;; (custom-set-variables
54-
;; '(flymake-phpcs-standard "/path/to/MyStandard"))
55-
56-
;; making sure that flymake-phpcs.el is on your load-path. If not,
57-
;; also add to your config:
58-
59-
;; (add-to-list 'load-path "~/.emacs.d/path/to/flymake-phpcs.el")
60-
61-
;;; Debugging
62-
63-
;; If phpcs isn't working for any reason, execute
64-
65-
;; M-x set-variable flymake-log-level <RET> 3
66-
67-
;; and you will see what is going wrong listed in the *Messages*
68-
;; buffer.
69-
70-
;;; Changelog
71-
72-
;; 20131128.1109 -- Release first.
32+
;; Please check the GitHub
33+
;; (https://github.com/senda-akiha/flymake-phpcs/)
34+
;; for more information.
7335

7436
;;; Code:
7537

0 commit comments

Comments
 (0)