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 6c9010a commit e7c27af
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,17 @@ SublimeLinter-cpplint

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

This linter plugin for SublimeLinter provides an interface to [cpplint](https://pypi.python.org/pypi/cpplint). It will be used with files that have the "C" or “C++” syntax.
This linter plugin for SublimeLinter provides an interface to [cpplint](https://pypi.python.org/pypi/cpplint).
It will be used with files that have the "C" or "C++" 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 using this plugin, you must ensure that `cpplint` is installed on your system. To install `cpplint`, do the following:
Before using this plugin, ensure that `cpplint` is installed on your system.
To install `cpplint`, do the following:

1. Install [Python](http://python.org/download/) and [pip](http://www.pip-installer.org/en/latest/installing.html).

Expand All @@ -20,7 +22,8 @@ Before using this plugin, you must ensure that `cpplint` is installed on your sy
[sudo] pip install cpplint
```

In order for `cpplint` to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. The docs cover [troubleshooting PATH configuration](http://sublimelinter.com/en/latest/troubleshooting.html#finding-a-linter-executable).
Please make sure that the path to `cpplint` is available to SublimeLinter.
The docs cover [troubleshooting PATH configuration](http://sublimelinter.com/en/latest/troubleshooting.html#finding-a-linter-executable).


## Settings
Expand Down

0 comments on commit e7c27af

Please sign in to comment.