Skip to content

Commit efda15f

Browse files
committed
clear getting started section
1 parent 59a6654 commit efda15f

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

readme.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,30 @@ The original name of this program was "C++check", but it was later changed to "C
1212

1313
Despite the name, Cppcheck is designed for both C and C++.
1414

15+
## Getting Started
16+
17+
Cppcheck is primarily a command-line tool, but this repository also includes a GUI frontend.
18+
19+
1. Build the project with CMake:
20+
21+
cmake -S . -B build
22+
cmake --build build
23+
24+
2. Run Cppcheck on a single file:
25+
26+
build/cppcheck file1.c
27+
28+
3. Run Cppcheck on a folder recursively:
29+
30+
build/cppcheck path
31+
32+
If you want the GUI, enable it when building:
33+
34+
cmake -S . -B build -DBUILD_GUI=ON
35+
cmake --build build
36+
37+
Then run the generated `cppcheck-gui` executable from the build output.
38+
1539
## Manual
1640

1741
A manual is available [online](https://cppcheck.sourceforge.io/manual.pdf).

0 commit comments

Comments
 (0)