Fixed SaveAs showing corrupted messages or crash of dlt-viewer. Rollback of QDltFile...
[dlt-viewer.git] / INSTALL.txt
1 DLT Viewer - Installation
2 =========================
3 Alexander Wenzel <Alexander.AW.Wenzel@bmw.de>
4
5 Instructions for installing DLT Viewer (GUI)
6 --------------------------------------------
7
8 * Install Qt5 SDK including Qt Creator and MinGW (or MSVC 2013 for 32bit and 64bit Windows builds)
9 * Tested with QT 5.5.1, QT 5.5.0, Qt 5.4.1 and QT 4.8.5
10 * Open project BuildDltViewer.pro in Qt Creator.
11 * Ensure that build options point to correct QT and MinGW.
12 * Build Release in Qt Creator.
13 * Optional Linux: set the library path in Qt Creator: Add variable to Projects/Build Settings/Build Environment: LD_LIBRARY_PATH = .
14
15 Instructions for installing DLT Viewer (Linux commandline)
16 ----------------------------------------------------------
17
18 * mkdir build
19 * cd build
20 * qmake-qt4 ../BuildDltViewer.pro
21 * make
22 * sudo make install
23 * sudo ldconfig
24 * Optional: set the library path: LD_LIBRARY_PATH = .
25
26 Create SDK (Windows)
27 --------------------
28
29 MinGW (32bit only):
30 * Install Qt5 SDK inclduing MinGW for Windows.
31 * If your Qt installation does not match "C:Qt\Qt5.5.1\5.5\mingw492_32",
32     you can set the correct path as environment variable "QTDIR" in your system properties.
33 * Adjust and run build_sdk_windows_qt5.bat batch file
34
35 Microsoft Visual C++ 2013 (32bit and 64bit):
36 * Install Qt5 SDK and MSVC 2013.
37 * If your Qt installation does not match "C:Qt\Qt5.5.1\5.5\msvc2013" (32bit) or "C:Qt\Qt5.5.1\5.5\msvc2013_64" (64bit),
38     you can set the correct path as environment variable "QTDIR" in your system properties.
39 * Adjust and run build_sdk_windows_qt5_MSVC.bat with optional parameter x86 or x86_amd64
40
41 The SDK will be installed to C:\Users\USERNAME\DltViewerSDK\
42
43 Optional: Prepare Installation Qwt (Windows)
44 --------------------------------------------
45
46 Some DLT Viewer plugins will use the Qwt library for displaying graphs.
47 The Qwt library must be compiled and installed before it can be used.
48
49 (Tested with Qwt 6.1.2)
50
51 MinGW (32bit only):
52 * Install Qt5 SDK inclduing MinGW for Windows.
53 * Extract Qwt Zip package
54 * Start Qt commandline from Start->Qt_5.x.x
55 * Change into Qwt directory
56 * Execute qmake qwt.pro
57 * Execute mingw32-make
58 * Execute mingw32-make install
59
60 Microsoft Visual C++ 2013 (32bit and 64bit):
61 * Install Qt5 SDK for Visual C++ 2013
62 * Extract Qwt Zip package
63 * If you like, you can adjust the installation path by changing the variable "QWT_INSTALL_PREFIX" in qwtconfig.pri
64 * Start Qt commandline from Start->Qt_5.x.x
65 * Change into Qwt directory
66 * Execute "C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\vcvarsall.bat" x86
67     for 32bit, or
68           "C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\vcvarsall.bat" x86_amd64
69     for 64bit.
70 * Execute qmake qwt.pro
71 * Execute "C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\bin\nmake.exe"
72 * Execute "C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\bin\nmake.exe" install
73
74 Create SDK (Linux)
75 ------------------
76
77 * Compile DLT Viewer as described in "Build DLT-viewer Linux"
78 * Call "sudo make install" to install dlt_viewer including libraries and headers for SDK
79
80 Create SDK Documentation (Windows)
81 ----------------------------------
82
83 * Install doxygen
84 * Change into project directory
85 * doxygen sdk/doxygen_dlt_viewer_plugininterface.cfg
86 * (Optional) doxygen sdk/doxygen_dlt_viewer.cfg
87 * (Optional) doxygen sdk/doxygen_dlt_viewer_qdlt.cfg
88 * You will find the documentation in the doc directory
89
90 Create SDK Documentation (Linux)
91 --------------------------------
92
93 * Install doxygen and graphviz
94 * Change into project directory
95 * doxygen sdk/doxygen_dlt_viewer_plugininterface.cfg
96 * (Optional) doxygen sdk/doxygen_dlt_viewer.cfg
97 * (Optional) doxygen sdk/doxygen_dlt_viewer_qdlt.cfg
98 * You will find the documentation in the doc directory
99
100 Create manuals documentation
101 ----------------------------
102
103 The manuals are generated with asciidoc.
104 Call 
105 asciidoc dlt_viewer_user_manual.txt
106 asciidoc dlt_viewer_plugins_programming_guide.txt
107 to generate html output.
108 To generate pdfs, call
109 sh onvert.sh 
110 from within the doc directory
111