Skip to content

Commit 905d32e

Browse files
author
Akiha Senda
committed
Update README.md
1 parent a30bc27 commit 905d32e

File tree

1 file changed

+44
-32
lines changed

1 file changed

+44
-32
lines changed

README.md

Lines changed: 44 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1-
flymake-google-cpplint.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 [this](https://github.com/flycheck/flycheck-google-cpplint).
6+
7+
# flymake-google-cpplint.el
38

49
cpplint.py by Google for Emacs with flymake-mode.
510

@@ -11,63 +16,70 @@ To use [cpplint.py](http://google-styleguide.googlecode.com/svn/trunk/cpplint/cp
1116

1217
You should be able to run
1318

14-
$ cpplint.py
19+
```sh
20+
$ cpplint.py
21+
```
1522

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

18-
Usage
19-
=====
25+
# Usage
2026

21-
Install cpplint.py
22-
------------------
27+
## Install cpplint.py
2328

2429
Example:
2530

26-
$ wget http://google-styleguide.googlecode.com/svn/trunk/cpplint/cpplint.py
27-
$ sudo mv cpplint.py /usr/local/bin/cpplint.py
28-
$ sudo chmod 755 /usr/local/bin/cpplint.py
31+
```sh
32+
$ wget http://google-styleguide.googlecode.com/svn/trunk/cpplint/cpplint.py
33+
$ sudo mv cpplint.py /usr/local/bin/cpplint.py
34+
$ sudo chmod 755 /usr/local/bin/cpplint.py
35+
```
2936

30-
Add to load-path
31-
----------------
37+
## Add to load-path
3238

3339
You'll need to add the directory containing `flymake-google-cpplint.el` to your `load-path`.
3440

3541
If not, also add to your config
3642

37-
(add-to-list 'load-path "~/.emacs.d/path/to/flymake-google-cpplint.el")
43+
```lisp
44+
(add-to-list 'load-path "~/.emacs.d/path/to/flymake-google-cpplint.el")
45+
```
3846

39-
Add to your Emacs config
40-
------------------------
47+
## Add to your Emacs config
4148

42-
(require 'flymake-google-cpplint)
43-
(add-hook 'c++-mode-hook 'flymake-google-cpplint-load)
49+
```lisp
50+
(require 'flymake-google-cpplint)
51+
(add-hook 'c++-mode-hook 'flymake-google-cpplint-load)
52+
```
4453

45-
Configure for cpplint.py
46-
------------------------
54+
## Configure for cpplint.py
4755

48-
(custom-set-variables
49-
'(flymake-google-cpplint-verbose "3")
50-
'(flymake-google-cpplint-linelength "120")
51-
...
52-
)
56+
```lisp
57+
(custom-set-variables
58+
'(flymake-google-cpplint-verbose "3")
59+
'(flymake-google-cpplint-linelength "120")
60+
...
61+
)
62+
```
5363

5464
For more information: [cpplint.py](http://google-styleguide.googlecode.com/svn/trunk/cpplint/cpplint.py)
5565

56-
cpplint.py command location
57-
---------------------------
66+
## cpplint.py command location
5867

5968
By default, the location of the `cpplint.py` command is searched.
6069

61-
(custom-set-variables
62-
'(flymake-google-cpplint-command "/path/to/cpplint.py"))
70+
```lisp
71+
(custom-set-variables
72+
'(flymake-google-cpplint-command "/path/to/cpplint.py"))
73+
```
6374

64-
Where to create temporary copy
65-
------------------------------
75+
## Where to create temporary copy
6676

6777
One of 'tempdir or 'inplace (default).
6878

69-
(custom-set-variables
70-
'(flymake-google-cpplint-location 'tempdir))
79+
```lisp
80+
(custom-set-variables
81+
'(flymake-google-cpplint-location 'tempdir))
82+
```
7183

7284
# Notes
7385

0 commit comments

Comments
 (0)