Skip to content

Commit

Permalink
Update README with more detailed info to build
Browse files Browse the repository at this point in the history
  • Loading branch information
vivaladav authored Sep 6, 2024
1 parent b1e7e06 commit 0e3a767
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
A Qt Creator plugin to get notified when your builds terminate and to track their stats.

### Project Status
Currently the plugin is usable and the project is under active development, but not ready for a proper release yet, hence no binary builds are available.
Currently the plugin is usable and the project is under development with regular releases to update it to the latest major version of Qt Creator.

People who want to start to use SIGBUILD need to build it from scratch following the instruction in the Development section.

Expand All @@ -28,17 +28,17 @@ That will allow me to spend more time on it and it will allow you to influence t
Currently the best way to use SIGBUILD is to build Qt Creator and then build the plugin.

Ideally you want to build SIGBUILD and Qt Creator against the same version of Qt and using the same (or compatible) compiler used to build the version of Qt Creator you run.
For example, Qt Creator 11.0.2 has been build against Qt 6.4.3 using gcc 10.3.1 on Linux and you should use a similar configuration when building Qt Creator and SIGBUILD.
For example, Qt Creator 14.0.0 has been built against Qt 6.7.2 using gcc 10.3.1 on Linux and you should use a similar configuration when building Qt Creator and SIGBUILD.

The current versio of SIGBUILD is tested to build against the 11.0 branch of Qt Creator.
The current versio of SIGBUILD is tested to build against the 14.0 branch of Qt Creator.
In case you need to build SIGBUILD for an old version of Qt Creator (<= 6) checkout the "QtCreator-6" tag with git.

### Dependencies
- Qt 6 - [online installer](https://www.qt.io/download-qt-installer) / [offline installer](https://www.qt.io/offline-installers)
- Qt Creator - [online installer](https://www.qt.io/download-qt-installer) / [offline installer](https://www.qt.io/offline-installers)
- Qt Creator source code - [git repository](https://code.qt.io/cgit/qt-creator/qt-creator.git/)

Note that when installing Qt you will need at least the following 2 modules:
Note that when installing Qt you will need at least the following modules:
- Desktop binaries (ex.: Desktop gcc 64bit)
- Qt Multimedia (additional libraries)
Also when installing Qt Creator you will need to include the following package:
Expand All @@ -47,14 +47,15 @@ Also when installing Qt Creator you will need to include the following package:
### How to build Qt Creator
From inside the cloned qt-creator directory:
- Open CMakeLists.txt
- Make sure to set CMake variable "Qt6_DIR" to the Qt6 directory
- Make sure to set the CMake variable "_Qt6_DIR_" to the cmake directory inside the latest Qt6 directory (ex.: _Qt/6.7.2/gcc_64/lib/cmake/Qt6_)
- Build

### How to build SIGBUILD
From inside the cloned SIGBUILD directory:
- Open CMakeLists.txt in Qt Creator
- Configure the project with a Qt6 kit
- Make sure to make the CMake variable "CMAKE_PREFIX_PATH" point to the Qt6 directory and to the Qt Creator build directory
- Make sure to set the CMake variable "_QtCreator_DIR_" to the cmake directory of the Qt Creator build directory (ex.: _qt-creator/build/Desktop_Qt_6_7_2-Debug/cmake_).
- Make sure to set the CMake variable "_Qt6_DIR_" to the cmake directory inside the latest Qt6 directory (ex.: _Qt/6.7.2/gcc_64/lib/cmake/Qt6_)
- Run CMake
- Build

Expand Down

0 comments on commit 0e3a767

Please sign in to comment.