Skip to content

Clear getting started section #8614

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bothrachhavi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clear getting started section #8614

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Copy Markdown
Collaborator

@danmar danmar Jun 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are already compile instructions below.

If this "Getting Started" section is targeted to normal users, then imho lets suggest installing cppcheck instead.

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).
Expand Down
Loading