Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 118 lines (92 sloc) 3.9 kB
f4dee71 @winterz describe the build dependencies
winterz authored
1 GammaRay uses the CMake buildsystem.
33882c9 @winterz Installation instructions.
winterz authored
2
3 Please see the comments at the top of CMakeLists.txt for
4 the available configuration options you can pass to cmake.
5
6 The installation directory defaults to /usr/local on UNIX
7 c:/Program Files on Windows and /Applications on MacOS.
31c4ac5 @winterz typo--
winterz authored
8 You can change this location by passing the option
33882c9 @winterz Installation instructions.
winterz authored
9 -DCMAKE_INSTALL_PREFIX=/install/path to cmake.
10
11 To build a debug version pass -DCMAKE_BUILD_TYPE=Debug to cmake.
12
f4dee71 @winterz describe the build dependencies
winterz authored
13 To build GammaRay you will need:
ad3a407 @vkrause Update build requirements.
vkrause authored
14 - CMake 2.8.11
ae70d58 @winterz blacklist MSVC compilers older than 2008
winterz authored
15 - a C++ compiler with C++11 lambda support
ad3a407 @vkrause Update build requirements.
vkrause authored
16 - Qt 4.8 or higher
f4dee71 @winterz describe the build dependencies
winterz authored
17
d34496b @winterz Revert "add options to disable VTK and Graphviz discovery"
winterz authored
18 Optional FOSS packages (eg. VTK, Graphviz, etc) provide extra functionality.
19 See the "Optional Dependencies" section below for more details.
20
0dfefae Add clang to the docs.
Stephen Kelly authored
21 Building on Unix with gcc or clang:
33882c9 @winterz Installation instructions.
winterz authored
22 % mkdir build
23 % cd build
24 % cmake ..
25 % make
26 % make install
27
bf3544d Microsoft does not have an uppercase 's'.
Stephen Kelly authored
28 Building on Windows with Microsoft Visual Studio:
33882c9 @winterz Installation instructions.
winterz authored
29 % mkdir build
30 % cd build
31 % cmake -G "NMake Makefiles" ..
32 % nmake
33 % nmake install
34
35 Building on Windows with mingw:
36 % mkdir build
37 % cd build
c140409 Fix instruction for MinGW build.
Stephen Kelly authored
38 % cmake -G "MinGW Makefiles" ..
33882c9 @winterz Installation instructions.
winterz authored
39 % mingw32-make
40 % mingw32-make install
697f6e2 @winterz add a big warning about -Bsymbolic-function
winterz authored
41
57b5b99 @bog-dan-ro Add Android build & usage instructions.
bog-dan-ro authored
42 Build on Android:
43 $ mkdir android-build
44 $ cd android-build
45 $ export ANDROID_NDK=~/path/to/android-ndk
46 $ cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchain-android.cmake \
47 -DGAMMARAY_PROBE_ONLY_BUILD=true \
48 -DCMAKE_PREFIX_PATH=/android/qt5/install/path \
49 -DCMAKE_INSTALL_PREFIX=/android/qt5/install/path ..
50 $ make [-j CPU_NUMBER+2]
51 $ make install
52
53 Using GammaRay on Android:
54 - add GammaRay probe to your android .pro file
55 myproject.pro
56 ....
57 android: QT += GammaRayProbe
58 ...
59 - build & deploy and run your project
60 - forward GammaRay's socket
61 $ adb forward tcp:11732 localfilesystem:/data/data/YOUR_ANDROID_PACKAGE_NAME(e.g. com.kdab.example)/files/+gammaray_socket
62 - run GammaRay GUI and connect to localhost:11732
63 - after you've finished, remove the forward:
64 $ adb forward --remove tcp:11732
65 or
66 $ adb forward --remove-all
67 to remove all forwards
68
69
2f060a2 @winterz CamelCase headers
winterz authored
70 == Building with Private Qt Headers ==
71 To build against private Qt headers (necessary for painter debugging/profiling)
457e24e @winterz Install.txt - clarify using -developer-build Qt config option
winterz authored
72 you must have a developer build version of Qt available (i.e. Qt must be
73 configured using the -developer-build option).
2f060a2 @winterz CamelCase headers
winterz authored
74
457e24e @winterz Install.txt - clarify using -developer-build Qt config option
winterz authored
75 Make sure the qmake found first in your execute comes from this build version.
2f060a2 @winterz CamelCase headers
winterz authored
76 For example, if your Qt build is in /data/Qt/4.8 then:
77 % export PATH=/data/Qt/4.8/bin:$PATH # on Linux using bash
78
79
8a5b7fa @winterz document how to force a Qt4 build
winterz authored
80 == Force a Qt4 build ==
81 On systems with both Qt4 and Qt5 available, the CMake buildsystem will always
82 attempt to use Qt5. To force a Qt build, pass -DGAMMARAY_ENFORCE_QT4_BUILD=true
83 to CMake, as in:
84 % cmake -DGAMMARAY_ENFORCE_QT4_BUILD=true
85
86
d34496b @winterz Revert "add options to disable VTK and Graphviz discovery"
winterz authored
87 == Optional Dependencies ==
88 GammaRay relies on optional (FOSS) dependencies to help provide some of its
89 functionality. For example, you'll need VTK (http://www.vtk.org) to build
90 the object visualizer and Graphviz (http://www.graphviz.org) for the state
91 machine visualizer.
92
93 When you run cmake it will inform you about these missing dependencies.
94
95 You can also force CMake to ignore any or all of the optional dependencies
96 by passing the option -DCMAKE_DISABLE_FIND_PACKAGE_<PACKAGE>=True.
97 For instance:
98 # tell cmake to ignore Graphiz and VTK
8a5b7fa @winterz document how to force a Qt4 build
winterz authored
99 % cmake -DCMAKE_DISABLE_FIND_PACKAGE_Graphviz=True -DCMAKE_DISABLE_FIND_PACKAGE_VTK=True
d34496b @winterz Revert "add options to disable VTK and Graphviz discovery"
winterz authored
100
2f060a2 @winterz CamelCase headers
winterz authored
101
697f6e2 @winterz add a big warning about -Bsymbolic-function
winterz authored
102 == Warning! ==
103 If your Qt is linked with the "-Bsymbolic-function" option preloading will be
104 broken. When this is enabled, references to global functions will be bound to
105 the shared object internally; therefore, the definition of the function will be
106 fixed and cannot be overwritten by preloading.
107
108 So, be sure that your distro-provided packages or your self-compiled packages
109 are not linked with this flag (check with `echo $LDFLAGS` before compiling).
110 For more info see: "man ld; search for "-Bsymbolic-function".
111
112 Known affected distros:
113
114 Ubuntu 10.10, 11.04
115
116 If you are affected by this, try the gdb injector instead by using the "-i gdb"
117 command line argument.
Something went wrong with that request. Please try again.