About Partisipate

Partisipate will become a simple to use Qt client for Coventry phone systems. In addition, it will eventually provide intercom and message chat groups, and offer user experiences for facility control.

Traditional Installation

Partisipate requires eXosip2 version 5.3.0 or later, Qt6, and either openssl or libressl to build and run. A typical "install" target is created to support local installation.

The preferred cmake build type for live installations is cmake -D CMAKE_BUILD_TYPE=RelWithDebugInfo . as this retains debug symbols in release builds which many gnu/linux packaging systems then strip off and separately generate a debug package.

Flatpak builds

TBD

Testing Partisipate

TBD

Distribution tarballs

The dist target is used to make detached tarballs with sources. This can be used to make packages for gnu/linux distributions and bsd ports, such as for arch, debian, alpine, redhat, etc. If the CMakeLists.txt refers to an already tagged release version, it will re-create the source tarball of that release at the time it was tagged. The master branch is usually ahead of the last release, so any new work will create a tarball based on your last git commit.

Detached tarballs can be used to configure and build this software without git, such as on a ci builder. It should not be used to make local changes outside of git, and cannot produce additional tarballs itself. The dist target only works from a git clone.

Participation and Documentation

Basic documentation is provided as markdown files. User operation and configuration should be similarly added here. An installation guide for various GNU/Linux distributions and BSD systems may also be added.

A more complete overview of project participation is provided in CONTRIBUTING.md. This project uses cmake, Qt6, and c++17 for core server development. I use the ctest framework for unit testing and gcovr for coverage reports. Partisipate can be built with gcc, clang, or msvc, and can be tested on just about any Qt6 supported platform, including bsd systems, MacOS, and Microsoft Windows.

In addition to producing testable debug builds the project can also be built for running unit tests. This is enabled by default for debug builds. To produce coverage reports you can cmake a debug build with -DCOVERAGE_TYPE=gcov set. You can then use the make the "coverage" target and produce coverage reports with gcovr or lcov. The "lint" target will validate code using cppcheck.

Support

Support is offered thru https://git.gnutelephony.org/partisipate/issues. When entering a new support issue, please mark it part of the support project. I also have dyfet@jabber.org. I may maintain system packaging for some GNU/Linux distributions, including Arch and Debian. In the future maybe other means of support will become possible.