Updated/Improved several readme files
This commit is contained in:
parent
62bc827eb0
commit
cc783b0186
|
@ -1,13 +1,11 @@
|
||||||
PCRE is a library that is used by the optional "rules" feature. (It adds
|
PCRE is a library that is used by the optional "rules" feature for the command
|
||||||
some additional features to the command line client.) It's readily available
|
line version of cppcheck. It is readily available on Linux and Mac OS X, but
|
||||||
on Linux and Mac OS X, but must be obtained separately for Windows.
|
must be obtained separately for Windows.
|
||||||
|
|
||||||
If you're using qmake to generate makefiles, the following behavior applies:
|
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
|
- If you're not on Windows, it assumes by default that you have PCRE and want
|
||||||
to enable rules support.
|
to enable rules support. You can disable rules support (removing the PCRE
|
||||||
|
|
||||||
- If you're not on Windows, you can disable rules support (removing the PCRE
|
|
||||||
dependency) by passing HAVE_RULES=no to qmake.
|
dependency) by passing HAVE_RULES=no to qmake.
|
||||||
|
|
||||||
- If you are on Windows, but have PCRE available, you can enable rules support
|
- 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
|
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
|
Windows
|
||||||
|
-------
|
||||||
|
|
||||||
Visual Studio
|
Visual Studio
|
||||||
|
|
||||||
To build PCRE, download the source code from www.pcre.org and
|
To build PCRE, download the source code from www.pcre.org and
|
||||||
CMake (http://www.cmake.org/cmake/resources/software.html).
|
CMake (https://cmake.org/download/). We assume you use Visual Studio 2015 -
|
||||||
Then I assume you use MSVC 2010 otherwise adapt the commands for your version.
|
otherwise adapt the commands for your version.
|
||||||
|
|
||||||
VS Solution file
|
VS Solution file
|
||||||
cmake . -G "Visual Studio 10"
|
cmake . -G "Visual Studio 14 2015"
|
||||||
Open PCRE.sln with VS IDE or via cmd:
|
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"
|
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
|
or using NMake
|
||||||
call "%VS100COMNTOOLS%..\..\VC\vcvarsall.bat" x86
|
call "%VS140COMNTOOLS%..\..\VC\vcvarsall.bat" x86
|
||||||
cmake . -G "NMake Makefiles"
|
cmake . -G "NMake Makefiles"
|
||||||
nmake
|
nmake
|
||||||
|
|
||||||
|
@ -47,14 +46,16 @@ or using MSYS
|
||||||
|
|
||||||
|
|
||||||
Linux
|
Linux
|
||||||
|
-----
|
||||||
|
|
||||||
The normal Makefile should work
|
The normal Makefile should work.
|
||||||
|
|
||||||
Install PCRE on Ubuntu might be needed:
|
Install PCRE on Ubuntu might be needed:
|
||||||
sudo apt-get install libpcre3 libpcre3-dev
|
sudo apt-get install libpcre3 libpcre3-dev
|
||||||
|
|
||||||
|
|
||||||
Mac OSX
|
Mac OSX
|
||||||
|
-------
|
||||||
|
|
||||||
Install PCRE:
|
Install PCRE:
|
||||||
|
|
||||||
|
@ -65,4 +66,3 @@ Ensure /path/to/pcre.h is in CXXFLAGS, e.g:
|
||||||
export CXXFLAGS=${CXXFLAGS}:/opt/local/include
|
export CXXFLAGS=${CXXFLAGS}:/opt/local/include
|
||||||
|
|
||||||
Or for MSVC copy pcre.lib and pcre.h in /externals directory.
|
Or for MSVC copy pcre.lib and pcre.h in /externals directory.
|
||||||
|
|
||||||
|
|
|
@ -5,17 +5,17 @@ with cppcheck and shows list of found errors.
|
||||||
|
|
||||||
Running
|
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:
|
depends on your operating system:
|
||||||
- Windows: download Qt4 from http://qt-project.org/downloads
|
- Windows: download Qt from http://www.qt.io/download/
|
||||||
- Linux: install Qt4 using your package manager, look for packages having Qt4
|
- 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.
|
in their name, e.g. for Ubuntu install libqt4-core and libqt4-gui.
|
||||||
|
|
||||||
Compiling
|
Compiling
|
||||||
---------
|
---------
|
||||||
Windows:
|
Windows:
|
||||||
- The easy ways are:
|
- 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.
|
QtCreator to build the GUI.
|
||||||
-- Download precompiled libraries for your platform and use your preferred
|
-- Download precompiled libraries for your platform and use your preferred
|
||||||
IDE/environment to build GUI. Be careful to download the correct version of
|
IDE/environment to build GUI. Be careful to download the correct version of
|
|
@ -49,9 +49,9 @@ make
|
||||||
|
|
||||||
### Visual Studio
|
### 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
|
### Qt Creator + MinGW
|
||||||
|
|
||||||
|
|
|
@ -41,12 +41,12 @@ Compiling
|
||||||
|
|
||||||
Visual Studio
|
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
|
toolset can be changed easily to older or newer versions. The solution contains platform
|
||||||
targets for both x86 and x64.
|
targets for both x86 and x64.
|
||||||
|
|
||||||
To compile with rules, select "Release-PCRE" or "Debug-PCRE" configuration.
|
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
|
Qt Creator + mingw
|
||||||
==================
|
==================
|
||||||
|
|
|
@ -6,8 +6,8 @@ http://wixtoolset.org/
|
||||||
|
|
||||||
You'll need:
|
You'll need:
|
||||||
- WiX
|
- WiX
|
||||||
- MSBuild (coming with Visual Studio (also with Express edition))
|
- MSBuild (coming with Visual Studio)
|
||||||
- VS 2010 CRT merge module
|
- VS 2015 CRT merge module
|
||||||
|
|
||||||
Configuring
|
Configuring
|
||||||
-----------
|
-----------
|
||||||
|
@ -27,12 +27,12 @@ Before building the installer make sure all the components are build:
|
||||||
- LIB dynamic link library (cppcheck-core.dll)
|
- LIB dynamic link library (cppcheck-core.dll)
|
||||||
- CLI executable (cppcheck.exe)
|
- CLI executable (cppcheck.exe)
|
||||||
- GUI executable (cppcheck-gui.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:
|
And that runtime files are available:
|
||||||
- Qt runtimes:
|
- Qt runtimes:
|
||||||
QtCore4.dll and QtGui4.dll
|
Qt5Core.dll, Qt5PrintSupport.dll, Qt5Widgets.dll, Qt5Gui.dll and platforms/qwindows.dll
|
||||||
- MS CRT merge module (Microsoft_VC100_CRT_x86.msm)
|
- 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
|
Build installer by giving this command line in VS command prompt (or run
|
||||||
vcvars32.bat in DOS prompt first to setup environment):
|
vcvars32.bat in DOS prompt first to setup environment):
|
||||||
|
|
Loading…
Reference in New Issue