Skip to content

Commit

Permalink
updated readme.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Marjamäki committed Feb 19, 2010
1 parent 5ce0c6d commit e30c49f
Showing 1 changed file with 64 additions and 28 deletions.
92 changes: 64 additions & 28 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,49 +5,85 @@ Cppcheck

About

The original name of this program is "C++check".
The name was changed to "cppcheck".
The original name of this program is "C++check" but it was later changed to "cppcheck".


Compiling

Any C++ compiler should work.

The Makefile works under Linux.
To make it work under Windows with DJGPP, change "g++" to "gxx".

To build cppcheck with qmake, run these commands:

Generate Makefile (use 'debug' instead of 'release' if doing developer build)
(If you are using Mac OS, you need to add "-spec macx-g++" to the command):
qmake -config release

Build command-line tool, GUI and autotests:
make

To build command-line tool only:
make sub-src

To build and run autotests:
make check

Any C++ compiler should work.

To build the GUI, you need Qt. The command line tool doesn't have any dependencies.

There are multiple compilation choices:
* SCons - cross platform build tool
* CMake - cross platform build tool
* qmake - cross platform build tool - but only the GUI can be built
* Visual Studio - Windows
* gnu make (for experts)
* g++ (for experts)


Scons
=====
Scons is a multi platform build tool. Python is required to run it.
scons


CMake
=====
CMake is a multi platform build tool with no dependencies.
cmake .
make


qmake
=====
You can use the gui/gui.pro file to build the gui.
cd gui
qmake
make


Visual Studio
=============
Use the cppcheck.sln file.


gnu make (for experts)
======================
A simple Makefile generator is available and you can use it like this:
g++ -o dmake tools/dmake.cpp lib/filelister.cpp
./dmake

The generated Makefile may need to be edited to fit your needs.
If it doesn't work, unfortunately we can't help you.


g++ (for experts)
=================
If you just want to build Cppcheck then you can use this command:
g++ -o cppcheck -Ilib cli/*.cpp lib/*.cpp

If it doesn't work, unfortunately we can't help you.


Cross compiling Win32 (CLI) version of Cppcheck in Linux

sudo apt-get install mingw32
make CXX=i586-mingw32msvc-g++ LDFLAGS="-lshlwapi"
mv cppcheck cppcheck.exe
sudo apt-get install mingw32
make CXX=i586-mingw32msvc-g++ LDFLAGS="-lshlwapi"
mv cppcheck cppcheck.exe

Usage

Run the cppcheck program without parameters and a help text will be shown.
Run the cppcheck program without parameters and a help text will be shown.


Recommendations

When the "--all" flag is given you may get a lot of error messages.
When the "--all" flag is given you may get a lot of error messages.


Webpage

http://www.sf.net/projects/cppcheck
http://www.sf.net/projects/cppcheck

0 comments on commit e30c49f

Please sign in to comment.