Using as a library

In order to use Communi as a library, build and install Communi using the standard mantra:

$ qmake
$ make
$ sudo make install

This integrates Communi with qmake from the corresponding Qt installation. To take Communi in use in your application, add the following lines to your qmake project (.pro) file:

CONFIG += communi

COMMUNI += core model util

This sets up the necessary include paths and linker rules in order to use the library. Notice that the needed Communi modules can be controlled via the COMMUNI qmake variable. The above example enables all available modules.

Building into application

In order to embed the whole Communi to an application, add the following line to your qmake project (.pro) file:

include(path/to/libcommuni/src/src.pri)

Alternatively, only specific module(s) can be included, for example:

include(path/to/libcommuni/src/core/core.pri)

include(path/to/libcommuni/src/util/util.pri)

This sets up the necessary include paths, and builds Communi sources into the application for convenient deployment on systems that do not have Communi installed. This option is also convenient when adding Communi as a Git submodule to your project tree.

Namespace support

The Communi source code can be compiled into a namespace to for example avoid symbol conflicts. In order to embed a namespaced Communi to an application, add the following lines to your qmake project (.pro) file:

DEFINES += IRC_NAMESPACE=Communi

include(path/to/libcommuni/src/src.pri)