From efda15f4c1e6eec44de583f3c89d9135dff9b1d1 Mon Sep 17 00:00:00 2001 From: bothrachhavi Date: Tue, 2 Jun 2026 13:35:33 +0530 Subject: [PATCH] clear getting started section --- readme.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/readme.md b/readme.md index 512a1ec1110..85ce6a5594f 100644 --- a/readme.md +++ b/readme.md @@ -12,6 +12,30 @@ The original name of this program was "C++check", but it was later changed to "C Despite the name, Cppcheck is designed for both C and C++. +## Getting Started + +Cppcheck is primarily a command-line tool, but this repository also includes a GUI frontend. + +1. Build the project with CMake: + + cmake -S . -B build + cmake --build build + +2. Run Cppcheck on a single file: + + build/cppcheck file1.c + +3. Run Cppcheck on a folder recursively: + + build/cppcheck path + +If you want the GUI, enable it when building: + + cmake -S . -B build -DBUILD_GUI=ON + cmake --build build + +Then run the generated `cppcheck-gui` executable from the build output. + ## Manual A manual is available [online](https://cppcheck.sourceforge.io/manual.pdf).