README.md: rewrote Installation section - refs #58

johnthagen · Mar 28, 2023 · c205b7b · c205b7b
1 parent fb4e604
commit c205b7b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 56 deletions.
diff --git a/README.md b/README.md
@@ -13,30 +13,15 @@ This project is supported with a free open source license of CLion from
 
 ## Installation
 
-Install the [`cppcheck` plugin][cppcheck_plugin] from the JetBrains Marketplace.
-
-See 
+- Install the `cppcheck` plugin from the JetBrains Marketplace: https://plugins.jetbrains.com/plugin/8143-cppcheck. See 
 [Installing, Updating and Uninstalling Repository Plugins](https://www.jetbrains.com/help/clion/managing-plugins.html) for more details.
 
-### Initial Plugin Configuration
-
-1. Install the [`cppcheck`](http://cppcheck.sourceforge.net/) tool using the instructions on its homepage. This plugin
-   does **not** bundle the Cppcheck tool itself, which must be installed separately.
-2. Install the [cppcheck plugin][cppcheck_plugin] into CLion.
-3. Configure the plugin with the **absolute** path to the Cppcheck executable into the `cppcheck path` option.
-    1. Windows
-        1. File | Settings | Cppcheck configuration
-        2. Usually the path is `C:\Program Files (x86)\Cppcheck\cppcheck.exe`
-    2. macOS: 
-        1. CLion | Preferences | Cppcheck configuration
-        2. In a terminal run `which cppcheck` to find the path to Cppcheck. If you installed it with 
-           [Homebrew](https://brew.sh/), the path will be `/usr/local/bin/cppcheck`.
-    3. Linux
-        1. File | Settings | Cppcheck configuration
-        2. In a terminal run `which cppcheck` to find the path to Cppcheck. If you installed it with your
-           system's package manager, it is probably located at `/usr/bin/cppcheck`. 
-
-[cppcheck_plugin]: https://plugins.jetbrains.com/plugin/8143
+- Install Cppcheck. Please refer to https://github.com/danmar/cppcheck#packages on how to obtain a version of Cppcheck for your platform.
+
+- 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`.
+
+- (Windows) The executable is found in the path you specified during the installation. By default this should be `C:\Program Files\Cppcheck\cppcheck.exe`.
+- (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`.
 
 ## Usage
 

diff --git a/resources/META-INF/plugin.xml b/resources/META-INF/plugin.xml
@@ -16,40 +16,7 @@
       <br/>
 
       <b>Usage:</b><br/>
-      <ul>
-        <li>
-          Install the <a href="http://cppcheck.sourceforge.net/">cppcheck tool</a> using directions on its homepage.
-          This plugin does <b>not</b> bundle the Cppcheck tool itself, which must be installed separately.
-        </li>
-        <li>Install this Cppcheck plugin into CLion</li>
-        <li>Configure the plugin with the <b>absolute</b> path to the Cppcheck executable into the
-        'Cppcheck Path' configuration field</li>
-        <ul>
-          <li>Windows
-            <ul>
-              <li>File | Settings | Cppcheck Configuration</li>
-              <li>Usually the path is C:\Program Files (x86)\Cppcheck\cppcheck.exe</li>
-            </ul>
-          </li>
-          <li>macOS
-             <ul>
-               <li>CLion | Preferences | Cppcheck Configuration</li>
-               <li>In a terminal run `which cppcheck` to find the path to Cppcheck.
-               If you installed it with <a href="https://brew.sh/">Homebrew</a>, the path will be
-               /usr/local/bin/cppcheck</li>
-             </ul>
-          </li>
-          <li>Linux
-            <ul>
-              <li>File | Settings | Cppcheck Configuration</li>
-              <li>In a terminal run `which cppcheck` to find the path to Cppcheck.
-              If you installed it with your system's package manager, it is probably located at
-              /usr/bin/cppcheck</li>
-            </ul>
-          </li>
-        </u1>
-      </ul>
-      <br/>
+        Please refer to <a href="https://github.com/johnthagen/clion-cppcheck#known-issues">Installation</a>.<br/>
 
       <b>Known issues:</b><br/>
         Please refer to <a href="https://github.com/johnthagen/clion-cppcheck#known-issues">Known Issues</a>.<br/>