From 5e85a3df6c156b1018073cc7a2730916951aa6e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Marjam=C3=A4ki?= Date: Sat, 2 Mar 2019 14:33:14 +0100 Subject: [PATCH] manual.md: Add a 'Getting started' chapter --- man/manual.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/man/manual.md b/man/manual.md index 606ee66c2..ad30a5ff3 100644 --- a/man/manual.md +++ b/man/manual.md @@ -19,4 +19,34 @@ many bugs that it doesn't detect. You will find more bugs in your software by testing your software carefully, than by using Cppcheck. You will find more bugs in your software by instrumenting your software, than by using Cppcheck. But Cppcheck can still detect some -of the bugs that you miss when testing and instrumenting your software. \ No newline at end of file +of the bugs that you miss when testing and instrumenting your software. + +## Getting started + +### GUI + +It is not required but creating a new project file is a good first step. There are a few options you can tweak to get +good results. + +In the project settings dialog, the first option is "Import project". It is recommended that you use this feature if +you can. Cppcheck can import: + - Visual studio solution / project + - Compile database (can be generated for instance by cmake) + - Borland C++ Builder 6 + +When you have filled out the project settings and click on OK; the Cppcheck analysis will start. + +### Command line + +A good first command to try is either... + +If you have a Visual studio solution / compile database (cmake/qbs/etc) / C++ Builder 6 project: + + cppcheck --enable=warning --project= + +Or: + + cppcheck --enable=warning + +You can extend and adjust the analysis in many ways later. +