Updated/Improved several readme files

This commit is contained in:
PKEuS 2015-11-01 10:29:44 +01:00
parent 62bc827eb0
commit cc783b0186
5 changed files with 29 additions and 29 deletions

View File

@ -1,13 +1,11 @@
PCRE is a library that is used by the optional "rules" feature. (It adds
some additional features to the command line client.) It's readily available
on Linux and Mac OS X, but must be obtained separately for Windows.
PCRE is a library that is used by the optional "rules" feature for the command
line version of cppcheck. It is readily available on Linux and Mac OS X, but
must be obtained separately for Windows.
If you're using qmake to generate makefiles, the following behavior applies:
- If you're not on Windows, it assumes by default that you have PCRE and want
to enable rules support.
- If you're not on Windows, you can disable rules support (removing the PCRE
to enable rules support. You can disable rules support (removing the PCRE
dependency) by passing HAVE_RULES=no to qmake.
- If you are on Windows, but have PCRE available, you can enable rules support
@ -17,27 +15,28 @@ If you're using qmake to generate makefiles, the following behavior applies:
build.bat, you need to run set HAVE_RULES=yes before each run of build.bat
Some temporary build instructions. This is work in progress.
Build instructions
------------------
Windows
-------
Visual Studio
To build PCRE, download the source code from www.pcre.org and
CMake (http://www.cmake.org/cmake/resources/software.html).
Then I assume you use MSVC 2010 otherwise adapt the commands for your version.
CMake (https://cmake.org/download/). We assume you use Visual Studio 2015 -
otherwise adapt the commands for your version.
VS Solution file
cmake . -G "Visual Studio 10"
cmake . -G "Visual Studio 14 2015"
Open PCRE.sln with VS IDE or via cmd:
call "%VS100COMNTOOLS%..\..\VC\vcvarsall.bat" x86
call "%VS140COMNTOOLS%..\..\VC\vcvarsall.bat" x86
MSBuild PCRE.sln /target:Build /property:Configuration="Release"
For 64-bit run: cmake . -G "Visual Studio 10 Win64"
For 64-bit target: cmake . -G "Visual Studio 14 2015 Win64"
or using NMake
call "%VS100COMNTOOLS%..\..\VC\vcvarsall.bat" x86
call "%VS140COMNTOOLS%..\..\VC\vcvarsall.bat" x86
cmake . -G "NMake Makefiles"
nmake
@ -47,14 +46,16 @@ or using MSYS
Linux
-----
The normal Makefile should work
The normal Makefile should work.
Install PCRE on Ubuntu might be needed:
sudo apt-get install libpcre3 libpcre3-dev
Mac OSX
-------
Install PCRE:
@ -65,4 +66,3 @@ Ensure /path/to/pcre.h is in CXXFLAGS, e.g:
export CXXFLAGS=${CXXFLAGS}:/opt/local/include
Or for MSVC copy pcre.lib and pcre.h in /externals directory.

View File

@ -5,17 +5,17 @@ with cppcheck and shows list of found errors.
Running
-------
You need Qt4 libraries installed in your system. Packages/files to install
You need Qt4 or Qt5 libraries installed in your system. Packages/files to install
depends on your operating system:
- Windows: download Qt4 from http://qt-project.org/downloads
- Linux: install Qt4 using your package manager, look for packages having Qt4
- Windows: download Qt from http://www.qt.io/download/
- Linux: install Qt using your package manager, look for packages having Qt
in their name, e.g. for Ubuntu install libqt4-core and libqt4-gui.
Compiling
---------
Windows:
- The easy ways are:
-- download Qt SDK from http://qt-project.org/downloads and use
-- download Qt SDK from http://www.qt.io/download/ and use
QtCreator to build the GUI.
-- Download precompiled libraries for your platform and use your preferred
IDE/environment to build GUI. Be careful to download the correct version of

View File

@ -49,9 +49,9 @@ make
### Visual Studio
Use the cppcheck.sln file. The file is configured for Visual Studio 2013, but the platform toolset can be changed easily to older or newer versions. The solution contains platform targets for both x86 and x64.
Use the cppcheck.sln file. The file is configured for Visual Studio 2015, but the platform toolset can be changed easily to older or newer versions. The solution contains platform targets for both x86 and x64.
To compile with rules, select "Release-PCRE" or "Debug-PCRE" configuration. pcre.lib (pcre64.lib for x64 builds) and pcre.h are expected to be in /extlibs then.
To compile with rules, select "Release-PCRE" or "Debug-PCRE" configuration. pcre.lib (pcre64.lib for x64 builds) and pcre.h are expected to be in /externals then.
### Qt Creator + MinGW

View File

@ -41,12 +41,12 @@ Compiling
Visual Studio
=============
Use the cppcheck.sln file. The file is configured for Visual Studio 2013, but the platform
Use the cppcheck.sln file. The file is configured for Visual Studio 2015, but the platform
toolset can be changed easily to older or newer versions. The solution contains platform
targets for both x86 and x64.
To compile with rules, select "Release-PCRE" or "Debug-PCRE" configuration.
pcre.lib (pcre64.lib for x64 builds) and pcre.h are expected to be in /extlibs then.
pcre.lib (pcre64.lib for x64 builds) and pcre.h are expected to be in /externals then.
Qt Creator + mingw
==================

View File

@ -6,8 +6,8 @@ http://wixtoolset.org/
You'll need:
- WiX
- MSBuild (coming with Visual Studio (also with Express edition))
- VS 2010 CRT merge module
- MSBuild (coming with Visual Studio)
- VS 2015 CRT merge module
Configuring
-----------
@ -27,12 +27,12 @@ Before building the installer make sure all the components are build:
- LIB dynamic link library (cppcheck-core.dll)
- CLI executable (cppcheck.exe)
- GUI executable (cppcheck-gui.exe)
- GUI translations (*.qm) - generated by the Qt's lrelease -tool
- GUI translations (*.qm) - generated by the Qt's lrelease tool
And that runtime files are available:
- Qt runtimes:
QtCore4.dll and QtGui4.dll
- MS CRT merge module (Microsoft_VC100_CRT_x86.msm)
Qt5Core.dll, Qt5PrintSupport.dll, Qt5Widgets.dll, Qt5Gui.dll and platforms/qwindows.dll
- MS CRT merge module (Microsoft_VC140_CRT_x86.msm or Microsoft_VC140_CRT_x64.msm)
Build installer by giving this command line in VS command prompt (or run
vcvars32.bat in DOS prompt first to setup environment):