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
|
# CMake + MS Visual Studio Code
Please see also [DLT Viewer: CMake + MS Visual Studio Code](../windows/build.md)
# Linux development environment setup
For DLT Viewer development on **MS Windows** please see [Windows development environment setup](../windows/build.md)
Configuration:
- Modern desktop Linux, Ubuntu LTS is recommended.
- Administrator rights `sudo`
- Build environment [install.sh](./install.sh)
- `sudo dlt-viewer/scripts/linux/install.sh`
- QT 5.12.10
- Default QT version published with each Ubuntu version is different. Good one is installed by `install.sh`
- Source QT5.12.10 environment. **Don't miss dot**.
- `. /opt/qt512/bin/qt512-env.sh`
- OR use `-DCMAKE_PREFIX_PATH=/opt/qt512/lib/cmake`
- MS VS Code
```bash
curl -sSL https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://packages.microsoft.com/repos/vscode stable main"
sudo apt update
sudo apt install code
```
- Ubuntu note
- Do not go to *Snap Store*.
- Do not install VS Code from Ubuntu App Gallery. This will provide [Flatpak](https://docs.flatpak.org/en/latest/sandbox-permissions.html) version of VS Code, which will run in the container and will have [limited access to the filesystem](https://stackoverflow.com/questions/55930071/vscode-cant-find-files-in-linux-system).
- Setup `.vscode` folder
- Copy content of `dlt-viewer/scripts/linux/.vscode_example/*.json` into `dlt-viewer/.vscode/`
- `.vscode` folder contains developer specific settings and not committed to the project.
# Development with Visual Studio Code
- Please see [windows/build.md](../windows/build.md) on how to use CMake and VS Code with DLT Viewer project.
# "Build from sources" use-case
- Do not use CMake install on Linux and macOS to install DLT Viewer system wide. CMake configuration is aiming Linux AppImage and macOS Application bundle generation.
- If you still need to install DLT Viewer system wide, please use `DLT_USE_STANDARD_INSTALLATION_LOCATION` or provide other installation configuration CMake variables.
- Build Release configuration and do `cmake --install .` for system wide install, or `cmake --install . --prefix DLTViewer` for local install.
- Set CMake variable `DLT_USE_STANDARD_INSTALLATION_LOCATION=ON`, see [CMakeLists.txt](../CMakeLists.txt)
- OR set `DLT_USE_STANDARD_INSTALLATION_LOCATION=OFF` and use `DLT_XXX_INSTALLATION_PATH` variables, see [build.sh](./build.sh)
# Build release package
- DLT Viewer for Linux is distributed as AppImage.
- See [install.md](./install.md) for details.
- AppImage approach is analogues to MacOS `DMG` format.
- To generate proper AppImage all project dependencies should be collected in `AppDir/usr/lib` folder and binaries should be patched with relative `DT_RUNPATHL`, for example `$ORIGIN/../lib`.
- [linuxdeploy](https://github.com/linuxdeploy/linuxdeploy) is used for this purpose with [linuxdeploy-plugin-qt](https://github.com/linuxdeploy/linuxdeploy-plugin-qt).
- https://docs.appimage.org/reference/best-practices.html#general-recommendations
- DT_RUNPATH documentation https://linux.die.net/man/1/ld
- `linuxdeploy` utility is wrapped into CPack External generator.
- [build.sh](./build.sh) script generates DLT Viewer AppImage and also produces TGZ file.
- Please use oldest supported Ubuntu LTS, currently Ubuntu 18.04, to create AppImage package compatible with most of desktop Linux installations.
|
