Skip to content

Commit 1d31591

Browse files
committed
some minor documentation improvements
1 parent 2fec3b6 commit 1d31591

2 files changed

Lines changed: 13 additions & 9 deletions

File tree

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
1-
# CLion-cppcheck
1+
# clion-cppcheck
22

3-
- Runs `cppcheck` on the fly while you write code.
4-
- Highlights lines and displays `cppcheck` error messages.
5-
- Supports passing options to `cppcheck`.
3+
A plugin for JetBrains IDEs to provide inspections for C/C++ files utilizing the static analyzer [Cppcheck](https://cppcheck.sourceforge.io/).
64

75
This project is supported with a free open source license of CLion from
86
[JetBrains](https://www.jetbrains.com/?from=clion-cppcheck).
97

8+
## Features
9+
10+
- Runs `Cppcheck` on the fly while you write code.
11+
- Highlights lines and displays `Cppcheck` error messages.
12+
- Supports passing options to `Cppcheck`.
13+
1014
## Installation
1115

12-
See
13-
[Installing, Updating and Uninstalling Repository Plugins](https://www.jetbrains.com/help/clion/managing-plugins.html)
16+
Install the [`cppcheck` plugin][cppcheck_plugin] from the JetBrains Marketplace.
1417

15-
- [`cppcheck` in JetBrains Plugin Repository][cppcheck_plugin]
18+
See
19+
[Installing, Updating and Uninstalling Repository Plugins](https://www.jetbrains.com/help/clion/managing-plugins.html) for more details.
1620

17-
### Initial Configuration
21+
### Initial Plugin Configuration
1822

1923
1. Install the [`cppcheck`](http://cppcheck.sourceforge.net/) tool using the instructions on its homepage. This plugin
2024
does **not** bundle the `cppcheck` tool itself, which must be installed separately.

resources/META-INF/plugin.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<vendor email="johnthagen@gmail.com" url="http://github.com/johnthagen">johnthagen</vendor>
66

77
<description><![CDATA[
8-
Cppcheck plugin for CLion.<br/><br/>
8+
A plugin for JetBrains IDEs to provide inspections for C/C++ files utilizing the static analyzer Cppcheck.<br/><br/>
99
1010
<b>Features:</b><br/>
1111
<ul>

0 commit comments

Comments
 (0)