Skip to content

Commit 5075a9b

Browse files
committed
README.md: rewrote Installation section - refs johnthagen#58
1 parent 2474b68 commit 5075a9b

File tree

2 files changed

+8
-56
lines changed

2 files changed

+8
-56
lines changed

README.md

+7-22
Original file line numberDiff line numberDiff line change
@@ -13,30 +13,15 @@ This project is supported with a free open source license of CLion from
1313

1414
## Installation
1515

16-
Install the [`cppcheck` plugin][cppcheck_plugin] from the JetBrains Marketplace.
17-
18-
See
16+
- Install the `cppcheck` plugin from the JetBrains Marketplace: https://plugins.jetbrains.com/plugin/8143-cppcheck. See
1917
[Installing, Updating and Uninstalling Repository Plugins](https://www.jetbrains.com/help/clion/managing-plugins.html) for more details.
2018

21-
### Initial Plugin Configuration
22-
23-
1. Install the [`cppcheck`](http://cppcheck.sourceforge.net/) tool using the instructions on its homepage. This plugin
24-
does **not** bundle the Cppcheck tool itself, which must be installed separately.
25-
2. Install the [cppcheck plugin][cppcheck_plugin] into CLion.
26-
3. Configure the plugin with the **absolute** path to the Cppcheck executable into the `cppcheck path` option.
27-
1. Windows
28-
1. File | Settings | Cppcheck configuration
29-
2. Usually the path is `C:\Program Files (x86)\Cppcheck\cppcheck.exe`
30-
2. macOS:
31-
1. CLion | Preferences | Cppcheck configuration
32-
2. In a terminal run `which cppcheck` to find the path to Cppcheck. If you installed it with
33-
[Homebrew](https://brew.sh/), the path will be `/usr/local/bin/cppcheck`.
34-
3. Linux
35-
1. File | Settings | Cppcheck configuration
36-
2. In a terminal run `which cppcheck` to find the path to Cppcheck. If you installed it with your
37-
system's package manager, it is probably located at `/usr/bin/cppcheck`.
38-
39-
[cppcheck_plugin]: https://plugins.jetbrains.com/plugin/8143
19+
- Install Cppcheck. Please refer to https://github.com/danmar/cppcheck#packages on how to obtain a version of Cppcheck for your platform.
20+
21+
- Go to the `Cppcheck Configuration` section in the settings of your respective JetBrains IDE and put the **absolute** path to the Cppcheck executable in the `Cppcheck Path`.
22+
23+
- (Windows) The executable is found in the path you specified during the installation. By default this should be `C:\Program Files\Cppcheck\cppcheck.exe`.
24+
- (Non-Windows) Use `which cppcheck` or `command -v cppcheck` on the command-line to get the location of the executable. The default depends on your system but should usually be `/usr/bin/cppcheck` or `/usr/local/bin/cppcheck`.
4025

4126
## Usage
4227

resources/META-INF/plugin.xml

+1-34
Original file line numberDiff line numberDiff line change
@@ -16,40 +16,7 @@
1616
<br/>
1717
1818
<b>Usage:</b><br/>
19-
<ul>
20-
<li>
21-
Install the <a href="http://cppcheck.sourceforge.net/">cppcheck tool</a> using directions on its homepage.
22-
This plugin does <b>not</b> bundle the Cppcheck tool itself, which must be installed separately.
23-
</li>
24-
<li>Install this Cppcheck plugin into CLion</li>
25-
<li>Configure the plugin with the <b>absolute</b> path to the Cppcheck executable into the
26-
'Cppcheck Path' configuration field</li>
27-
<ul>
28-
<li>Windows
29-
<ul>
30-
<li>File | Settings | Cppcheck Configuration</li>
31-
<li>Usually the path is C:\Program Files (x86)\Cppcheck\cppcheck.exe</li>
32-
</ul>
33-
</li>
34-
<li>macOS
35-
<ul>
36-
<li>CLion | Preferences | Cppcheck Configuration</li>
37-
<li>In a terminal run `which cppcheck` to find the path to Cppcheck.
38-
If you installed it with <a href="https://brew.sh/">Homebrew</a>, the path will be
39-
/usr/local/bin/cppcheck</li>
40-
</ul>
41-
</li>
42-
<li>Linux
43-
<ul>
44-
<li>File | Settings | Cppcheck Configuration</li>
45-
<li>In a terminal run `which cppcheck` to find the path to Cppcheck.
46-
If you installed it with your system's package manager, it is probably located at
47-
/usr/bin/cppcheck</li>
48-
</ul>
49-
</li>
50-
</u1>
51-
</ul>
52-
<br/>
19+
Please refer to <a href="https://github.com/johnthagen/clion-cppcheck#known-issues">Installation</a>.<br/>
5320
5421
<b>Known issues:</b><br/>
5522
Please refer to <a href="https://github.com/johnthagen/clion-cppcheck#known-issues">Known Issues</a>.<br/>

0 commit comments

Comments
 (0)