dde-kwin is a kwin plugin library developed based on Qt.
- Use
cmake
for project management. - Use
QTest
for unit testing. - Use
reuse
for open source protocol checking. - Support generating unit test coverage reports.
g++
compilers are use.- Compatible with
Qt6
andQt5
. - Support for compiling as a
debian
platform installer.
Catalog | Description |
---|---|
.reuse/ | license declaration file, the project should use the reuse tool for license declaration |
.gitignore | The git filter list, used to filter files that don't need to be pushed to the repository |
README.md | Project Overview Document |
LICENSE | License agreement file, the file to github such repository use, the project should use reuse tool, but the agreement must be unified, generally GPL-v3 |
CMakeLists.txt | Project files can be placed in the outermost |
[debian/] | Required files for debian packaging |
LINCENSES/ | License agreement directory, where all license agreements for the project are stored |
[translations/ ] | Store localization-related files, such as .ts |
This style guide follows the deepin-styleguide and is refined and split on its basis to form a style guide applicable to development libraries.
- The development library must be based on
Qt
and can depend ondtkcore
, but is not allowed to depend ondtkgui
anddtkwidget
, in order to minimize dependencies, and should not depend ondtkcore
if it does not need to. - Try to use pre-declarations, unlike deepin-tyleguide here, as a development library, to try to minimize dependencies on header files.
- Use descriptive naming whenever possible, use full word combinations whenever possible, and be sure not to use abbreviations or shorthand.
The project name should start with the three letters dtk
and be all lowercase, no ligatures are allowed, e.g. dtkpower
, dtkpowermanager
.