Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jfcherng committed Feb 5, 2018
1 parent fe5b14c commit 5108a35
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ SublimeLinter-gcc

This linter plugin for [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter3) provides an interface to [gcc](https://gcc.gnu.org/) or other gcc-like (cross-)compiler.
It will be used with files that have the C/C++ syntax.
If you are using [clang](https://clang.llvm.org), you should consider [Sublime​Linter-contrib-clang](https://github.com/nirm03/SublimeLinter-clang).
If you are using [clang](https://clang.llvm.org), you should consider [Sublime​Linter-clang](https://github.com/nirm03/SublimeLinter-clang).


Installation
Expand Down Expand Up @@ -96,8 +96,8 @@ Here is an example settings:
Notes
=====

- [Here](https://gcc.gnu.org/onlinedocs/gcc-7.2.0/gcc/Warning-Options.html#Warning-Options)
is the official list of warning options in gcc 7.2.0. I prefer turn on all warnings
- [Here](https://gcc.gnu.org/onlinedocs/gcc-7.3.0/gcc/Warning-Options.html#Warning-Options)
is the official list of warning options in gcc 7.3.0. I prefer turn on all warnings
via `-Wall` (this is default for this plugin) and then suppress unwanted warnings via `-Wno-` prefix.

- Flag `-fsyntax-only` gives a much faster syntax-only checking but
Expand Down Expand Up @@ -143,7 +143,7 @@ Please note that modifications should follow these coding guidelines:
- Indent is 4 spaces.
- Code should pass flake8 and pep257 linters.
- Vertical whitespace helps readability, don’t be afraid to use it.
- Please use descriptive variable names, no abbrevations unless they are very well known.
- Please use descriptive variable names, no abbreviations unless they are very well known.

Thank you for helping out!

Expand Down

0 comments on commit 5108a35

Please sign in to comment.