Skip to content

Latest commit

 

History

History
113 lines (78 loc) · 2.55 KB

INSTALL.md

File metadata and controls

113 lines (78 loc) · 2.55 KB
Raw

Building GCodeWorkShop

GCodeWorkShop is written in C++ using the Qt5 framework. In general, the following steps are needed to build it:

  • Install the C++11 compiler supported by Qt SDK. You should also install the make utility.
  • Install Qt utilities such as qmake, moc, lrelease and the resource packer.
  • Install the Qt5 framework with version 5.6 or higher.
  • Obtain and unzip the GCodeWorkShop source code.
  • Create a build folder and navigate to it.
  • Run qmake specifying the path to GCodeWorkShop sources.
  • Run make to build the application.

Building in Ubuntu

Install the following packages.

apt update
apt install build-essential \
qtbase5-dev qttools5-dev-tools libqt5serialport5-dev

Switch to the folder with sources. Now you can either build the application step by step or use the script to automatically build the application and create an installation package.

Step-by-step build

mkdir -p build
cd build
qmake -r ..
make lrelease -j $(nproc)
qmake -r ..
make -j $(nproc)

Automatically build and create an package

Run script:

install/deb-build.sh

The script creates a .deb package in the current folder and does not require root privileges.

Peculiarities of building with Qt6

Install the following packages. Note that Ubuntu jammy (version 22) does not have the qt6-serialport-dev package and libqt6serialport6-dev should be installed instead.

apt update
apt install build-essential \
qt6-base-dev qt6-base-dev-tools qt6-serialport-dev qt6-l10n-tools qt6-translations-l10n

Next, when building step-by-step, you should type qmake6 instead of qmake or add the -q qmake6 switch when running the automatic build script.

Building in windows with MSYS2

Install the following packages.

pacman -Syu
pacman -S make mingw-w64-x86_64-gcc mingw-w64-x86_64-nsis \
    mingw-w64-x86_64-qt5-tools mingw-w64-x86_64-qt5-translations \
    mingw-w64-x86_64-qt5-base mingw-w64-x86_64-qt5-serialport

Switch to the folder with sources. Now you can either build the application step by step or use the script to automatically build the application and create an installer.

Step-by-step build

mkdir -p build
cd build
qmake -r ..
make lrelease -j $(nproc)
qmake -r ..
make -j $(nproc)

Automatically build and create an installer

Run script:

install/win-msys2-build.sh

The script creates a .exe installer in the current folder.