Skip to content

Commit 1cf2ccf

Browse files
committed
feature/ updated readme with gifs
1 parent f65c8c3 commit 1cf2ccf

5 files changed

Lines changed: 9 additions & 2 deletions

File tree

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,30 @@
11
# Cppcheck Official
22

3+
34
**Cppcheck Official** is a Visual Studio Code extension that runs [cppcheck](https://cppcheck.sourceforge.io/) against C/C++ files upon save and reports any warnings or errors in the Problems panel.
45

6+
![GIF showing example of warnings output from cppcheck](./images/check_result.gif)
7+
58
## Features
69

710
- **On-save linting**: When you save a c/cpp file, `cppcheck` is automatically run on that file.
811
- **Per-file diagnostics**: Only diagnostics relevant to the saved file are displayed.
912
- **Configurable severity threshold**: Filter out messages below a chosen severity level (`info`, `warning`, or `error`).
10-
- **Set C/C++ standard**: Easily specify `--std=<id>` (e.g. `c++17`, `c99`, etc.).
1113
- **Diagnostic cleanup**: When you close a file, its diagnostics are automatically cleared.
12-
- **Project file support**: You can feed your project file to cppcheck through the `--project` flag in the `cppcheck-official.arguments` field in the extension settings.
14+
- **Project file support**: You can feed your project file to cppcheck through the `--project` flag in the `cppcheck-official.arguments` field in the extension settings. (See GIF below)
15+
![GIF showing where to set up project file](./images/project_file.gif)
1316
- **Warning notes**: Display notes for warnings when those are available
17+
- **Warning type suppression**: Suppress warnings with comments on the form `// cppcheck suppress >warning type<`. Cppcheck also warns about unmatched suppressions.
18+
![GIF showing how to suppress warnings](./images/suppression.gif)
1419

1520
## Requirements
1621

1722
**Cppcheck** must be installed on your system.
1823
- By default, this extension looks for `cppcheck` on the system PATH.
1924
- Alternatively, specify a custom executable path using the `cppcheck-official.path` setting.
2025

26+
![GIF showing location of path setting](./images/cppcheck_path.gif)
27+
2128
Examples of installing Cppcheck:
2229
- On Linux (Debian/Ubuntu), install via `sudo apt-get install cppcheck`.
2330
- On macOS with Homebrew: `brew install cppcheck`.

images/check_result.gif

61.1 MB
Loading

images/cppcheck_path.gif

17.7 MB
Loading

images/project_file.gif

19.7 MB
Loading

images/suppression.gif

50.1 MB
Loading

0 commit comments

Comments
 (0)