Skip to content

Commit dae944d

Browse files
committed
restored gifs but of smaller size
1 parent da7fd05 commit dae944d

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,27 @@
33

44
**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.
55

6-
<video src="./images/check_result.mp4" controls width="360"></video>
6+
![GIF showing example of warnings output from cppcheck](./images/check_result.gif)
77

88
## Features
99

1010
- **On-save linting**: When you save a c/cpp file, `cppcheck` is automatically run on that file.
1111
- **Per-file diagnostics**: Only diagnostics relevant to the saved file are displayed.
1212
- **Configurable severity threshold**: Filter out messages below a chosen severity level (`info`, `warning`, or `error`).
1313
- **Diagnostic cleanup**: When you close a file, its diagnostics are automatically cleared.
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 video below)
15-
16-
<video src="./images/project_file.mp4" controls width="360"></video>
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)
1716
- **Warning notes**: Display notes for warnings when those are available
1817
- **Dynamic config**: The extension supports running a script to generate arguments to pass to cppcheck. This can be done by including the command in the argument field wrapped with \${}, e.g. `--suppress=memleak:src/file1.cpp ${bash path/to/script.sh}`. The script is expected to output the argument(s) wrapped with \${}. If the script e.g. creates a project file it should print out as `${--project=path/to/projectfile.json}`. This output will be spliced into the argument string as such: `--suppress=memleak:src/file1.cpp --project=path/to/projectfile.json`.
1918

20-
<video src="./images/suppression.mp4" controls width="360"></video>
19+
![GIF showing how to suppress warnings](./images/suppression.gif)
2120
## Requirements
2221

2322
**Cppcheck** must be installed on your system.
2423
- By default, this extension looks for `cppcheck` on the system PATH.
2524
- Alternatively, specify a custom executable path using the `cppcheck-official.path` setting.
2625

27-
<video src="./images/cppcheck_path.mp4" controls width="360"></video>
26+
![GIF showing location of path setting](./images/cppcheck_path.gif)
2827

2928
Examples of installing Cppcheck:
3029
- On Linux (Debian/Ubuntu), install via `sudo apt-get install cppcheck`.

0 commit comments

Comments
 (0)