Building Pegasus

Pegasus is a C++ program that uses the Qt framework. To build it for on your OS or device, you'll need a C++11 supporting compiler (eg. G++ 4.9, Visual Studio 2017), Qt 5.8 or later (version is important!) for your platform, and at least the following additional Qt components:

Qt also provides a graphical IDE called Qt Creator, which you can use if you wish, but it's not a requirement. For installing Qt, see this page.

Using Qt Creator

  1. Open Qt Creator and open the project file (pegasus.pro)
  2. Qt Creator will ask you which Qt setup ("kit") you want to use (in case you've installed multiple versions), and where you want to place the generated files (see Details). If everything's OK, click Configure Project.
  3. (optional) Change the configuration (see here)
  4. In the bottom left corner, on the sidebar of Qt Creator, you can find 4 buttons:

    • with the button that looks like a desktop monitor, you can change the build type (optimized Release build or development-friendly but slower Debug build)
    • the green arrow will build and run the program
    • the green arrow with a bug will also open several debug toolbars
    • the hammer will build the project but won't start the application
  5. Change the build type to Release, and press the green arrow to build and run the project.

Using the command line

  1. Create a build directory somewhere, and cd into it
  2. Call qmake, the configuration tool of Qt: /path/to/qmake path/to/project [options].
    • If you have multiple Qt versions installed, make sure you call the right qmake. If you've installed using the official release from the Qt site, you can find it in [qt-installdir]/Qt5/[version]/gcc_64/bin (you can add it to your $PATH if you want, but it's not necessary).
    • You can also change some configuration options, which you can find here.
  3. Call make
  4. (optional) Call make install

Configuration options

You can change build parameters to qmake (the Qt configuration tool) by appending KEY=VALUE pairs to its command line call. If you're using Qt Creator, you can find these settings on the Projects -> Build settings tab, where you can modify the Additional arguments option (see here).

build steps screenshot

 

You can use the following parameters:

OptionDescription
INSTALLDIRThe general installation directory used by make install. Defaults to /opt/pegasus-frontend on Linux and C:\pegasus-frontend on Windows. You can fine tune the installation directory of some components by other options.
INSTALL_BINDIRThe installation directory of the runtime binary ("exe"). Defaults to INSTALLDIR.
INSTALL_DATADIRThe installation directory of the data files, eg. default themes. Defaults to INSTALLDIR.
INSTALL_ICONDIR[Linux only] The installation directory of the icon file. Defaults to INSTALLDIR (to make it portable), /usr/share/pixmaps is recommended if you want to install Pegasus system-wide.
INSTALL_DESKTOPDIR[Linux only] The installation directory of the desktop entry. Defaults to INSTALLDIR (to make it portable), /usr/share/applications is recommended if you want to install Pegasus system-wide.