forked from COVESA/dlt-viewer
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathINSTALL.txt
139 lines (110 loc) · 5.25 KB
/
INSTALL.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
DLT Viewer - Installation
=========================
Alexander Wenzel <[email protected]>
Instructions for installing DLT Viewer (GUI)
--------------------------------------------
* Install Qt5 SDK including Qt Creator and MinGW (or MSVC 2013 for 32bit and 64bit Windows builds)
* Tested with QT 5.5.1, QT 5.5.0
* Open project BuildDltViewer.pro in Qt Creator.
* Ensure that build options point to correct QT and MinGW / MSVC.
* Build Release in Qt Creator or via CMake (see last).
* Optional Linux: set the library path in Qt Creator: Add variable to Projects/Build Settings/Build Environment: LD_LIBRARY_PATH = .
Instructions for installing DLT Viewer (Linux commandline)
----------------------------------------------------------
* mkdir build
* cd build
* qmake-qt5 ../BuildDltViewer.pro
* make
* sudo make install
* sudo ldconfig
* Optional: set the library path: LD_LIBRARY_PATH = .
Create SDK (Windows)
--------------------
MinGW (32bit only):
* Install Qt5 SDK inclduing MinGW for Windows.
* If your Qt installation does not match "C:\Qt\Qt5.5.1\5.5\mingw492_32",
you can set the correct path as environment variable "QTDIR" in your system properties.
* Adjust and run build_sdk_windows_qt5.bat batch file
Microsoft Visual C++ 2013 (32bit and 64bit):
* Install Qt5 SDK and MSVC 2013 (you can use the free "express" version).
* If your Qt installation does not match "C:\Qt\Qt5.5.1\5.5\msvc2013" (for 32 bit) or "C:\Qt\Qt5.5.1\5.5\msvc2013_64" (for 64 bit),
you can set the correct path as environment variable "QTDIR" in your system properties.
* Adjust and run build_sdk_windows_qt5_MSVC.bat with optional parameter x86 or x86_amd64 (the current system's architecture is used by default).
The SDK will be installed to C:\Users\%USERNAME%\DltViewerSDK\
Optional: Prepare Installation Qwt (Windows)
--------------------------------------------
Some DLT Viewer plugins will use the Qwt library for displaying graphs.
The Qwt library must be compiled and installed before it can be used.
(Tested with Qwt 6.1.2)
MinGW (32bit only):
* Install Qt5 SDK inclduing MinGW for Windows.
* Extract Qwt Zip package
* Start Qt commandline from Start->Qt_5.x.x
* Change into Qwt directory
* Execute qmake qwt.pro
* Execute mingw32-make
* Execute mingw32-make install
Microsoft Visual C++ 2013 (32bit and 64bit):
* Install Qt5 SDK for Visual C++ 2013 (you can use the free "express" version)
* Extract Qwt Zip package
* If you like, you can adjust the installation path by changing the variable "QWT_INSTALL_PREFIX" in qwtconfig.pri
* Start Qt commandline from Start->Qt_5.x.x
* Change into Qwt directory
* Execute "C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\vcvarsall.bat" x86
for 32bit, or
"C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\vcvarsall.bat" x86_amd64
for 64bit.
* Execute qmake qwt.pro
* Execute "C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\bin\nmake.exe"
* Execute "C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\bin\nmake.exe" install
Create SDK (Linux)
------------------
* Compile DLT Viewer as described in "Build DLT-viewer Linux"
* Call "sudo make install" to install dlt_viewer including libraries and headers for SDK
Create SDK Documentation (Windows)
----------------------------------
* Install doxygen and graphviz
* Change into project directory
* doxygen sdk\doxygen_dlt_viewer_plugininterface.cfg
* (Optional) doxygen sdk\doxygen_dlt_viewer.cfg
* (Optional) doxygen sdk\doxygen_dlt_viewer_qdlt.cfg
* You will find the documentation in the doc directory
Create SDK Documentation (Linux)
--------------------------------
* Install doxygen and graphviz
* Change into project directory
* doxygen sdk/doxygen_dlt_viewer_plugininterface.cfg
* (Optional) doxygen sdk/doxygen_dlt_viewer.cfg
* (Optional) doxygen sdk/doxygen_dlt_viewer_qdlt.cfg
* You will find the documentation in the doc directory
Create manuals documentation
----------------------------
The manuals are generated with asciidoc.
Call
asciidoc dlt_viewer_user_manual.txt
asciidoc dlt_viewer_plugins_programming_guide.txt
to generate html output.
To generate pdfs, call
sh convert.sh
from within the doc directory
Instructions for building DLT Viewer with CMake (Linux commandline)
----------------------------------------------------------
CMake is a "meta" make system. This means CMake creates a make system
for various make solutions including command line build tools like
"Unix Makefiles", or IDE tools like "Visual Studio".
See: https://cmake.org/cmake/help/v3.0/manual/cmake-generators.7.html
CMake encourages the "out of source" build paradigm. Assuming DLT Viewer
code has been unpacked in path/src, we encourage not building in that directory
* mkdir build
* cd build
* cmake "GENERATOR OF CHOICE" path/src
At this stage, CMake will have produced a set of filesthat can be used by the
selected make system, be it "Unix Makefiles", "Visual Studio 6" or other.
Often a DLT-Viewer.EXTENSION file will be present in the build directory.
In the case of "Unix Makefiles" building is now as simple as
* sudo make install
* sudo ldconfig
* Optional: set the library path: LD_LIBRARY_PATH = .
Various solutions exist for cmake configuration to be informed about
non-standard installation paths for required components. See CMake
documentation for details. (hint: QTDIR)