Welcome and thank you for your interest in contributing.
Project uses Qt 5.12.8 (Linux) and Qt 5.15.2 (Windows) with Qt Creator being the preferred development environment.
All code is situated in src directory.
To build project under Linux, the following packages are required (in addition to Qt Creator):
- build-essentials
- libqt5x11extras5-dev
- qtbase5-dev
- lintian
To build executables, one can use make:
make clean
make
To build debian package:
make clean
make package
To build project under Windows, in adition to Qt Creator with MinGW compiler, one also needs Git Bash to execute build script:
./WinMake.sh
To make package you need InnoSetup application and executing build script with
package argument:
./WinMake.sh package
To run unit tests, you will need to create a new build configuration. To do so
go to Projects and use Add button to add it. Under qmake build configuration add
CONFIG+=test in Additional arguments. If you press Run, it will now execute
all test cases.
Fixes can be contributed using pull requests. Do note project is under MIT license and any contribution will inherit the same.
LF line ending is strongly preferred. To have Git check it for you, configure
core.whitespace setting:
git config core.whitespace blank-at-eol,blank-at-eof,space-before-tab,cr-at-eol
All textual files should be encoded as UTF-8 without BOM.
For non code files (xml, etc), use the best judgment. Albeit, do note that tab
character should be avoided and a number of space characters should be used
instead (4 being preferred).
Code uses K&R coding style. Please do make sure any contribution follows the coding style already in use.