Skip to content

A Quick Dev Guide prerequisites

Jump to bottom
mathildemerle edited this page Oct 31, 2024 · 9 revisions

Minimum supported OS

  • Ubuntu 22
  • Fedora 37
  • Mac 10.15
  • Windows 10

Pre-requisites for running the binary

  • for Ubuntu: sudo apt install qtbase5-dev qt5-qmake qttools5-dev qttools5-dev-tools qtwebengine5-dev libqt5svg5-dev libqt5websockets5-dev libqt5x11extras5-dev
  • for Fedora: sudo yum install qt5-qtsvg-devel mesa-libGLU-devel qt5-qtquickcontrols2-devel qt5-qtx11extras-devel libX

Pre-requisites for compilation

On Linux

CMake should be >= CMake 3.24. You can check with cmake --version.

Qt version has to be 5.12 to 5.15. You can check with qmake --version.

On Ubuntu

sudo apt install git g++ cmake cmake-curses-gui
sudo apt install qtbase5-dev qt5-qmake qttools5-dev qttools5-dev-tools qtwebengine5-dev libqt5svg5-dev libqt5websockets5-dev libqt5x11extras5-dev
sudo apt install libboost-all-dev libxt-dev

if CMake version is too old

sudo apt purge --auto-remove cmake
sudo apt update && \
sudo apt install -y software-properties-common lsb-release && \
sudo apt clean all
wget -O - https://apt.kitware.com/keys/kitware-archive-latest.asc 2>/dev/null | gpg --dearmor - | sudo tee /etc/apt/trusted.gpg.d/kitware.gpg >/dev/null
sudo apt-add-repository "deb https://apt.kitware.com/ubuntu/ $(lsb_release -cs) main"
sudo apt update
sudo apt install cmake

On Fedora

sudo yum install cmake qt5-qtbase-devel libXt-devel boost-devel qtwebkit-devel qt5-qttools qt5-qttools-devel qt5-qtdeclarative-devel qt5-qtx11extras-devel qt5-qtsvg-devel

On Mac

You need to install XCode 12.4 from https://xcodereleases.com/.

In a terminal:

xcode-select --install
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" # from https://brew.sh
brew update
brew install cmake
brew install qt5
brew install boost

Qt 5.12 or 5.13 is needed. Alternatively to brew, you can find here a Qt Online Installer (for macOS 10.15) or a Qt Offline Installer to install the 5.12.12 version. You'll need to check the "Archive" parameter to display it. Then add Qt to your PATH or to Qt5_DIR during cmake step, for instance /Users/your_name/Qt5.12.12/5.12.12/clang_64/lib/cmake/Qt5.

On Windows

See en_win_Development-environement-setup

To compile the application on Windows with WSL2 through Ubuntu please look at the Linux part of this tutorial.

Prerequisites changes for dev branch

  • Ubuntu: sudo apt install libglvnd-dev
  • Windows: Visual Studio 16 2019 minimum
  • Qt 5.15

To install Qt5.15 with Qt Online Installer:

  • Choose "Installation personnalisée" and an installation directory
  • Choose Archive, remove the other filters, and filter
  • Choose minimum: Qt5.15.2 (only module macOS or the one for your OS) for a very small installation (for CI)
  • Add if needed Debug information, and/or Sources to dev.
Clone this wiki locally