The name is the folder name. The fancyname is the project name used in CMake.
description: Library doing X and Y
fancyname: The FancyName # optional, else replaced by the `project()` value of the `CMakeLists.txt`
maintainer: ochurlaud # optional, replaced by The KDE Community
group: frameworks # optional
subgroup: tier 1 # optional, a group must be defined
type: functional # optional
logo: relative/path/to/logo.png # Used only if not part of a group
platforms: # optional, name accepted: all, Linux, Windows, MacOSX
note: Functional only with running BlueZ 5 # optional
public_lib: true # if not defined, the library is ignored
public_source_dirs: # optional, default to src, must be a list
public_doc_dir: docs # optional, default to docs
public_example_dir: examples # optional, default to examples
portingAid: true/false # optional, default to false
deprecated: true/false # optional, default to false
libraries: KF5::MyLib # optional
cmakename: KF5BluezQt # optional
irc: kde # optional, overwrite group field, if both not defined, default to kde-devel
mailinglist: mylib-dev # optional, overwrite group field, if both not defined, default to kde-devel
group_info: # optional, only once per group
name: frameworks # optional, else the name is defined by the 'group' key above.
fancyname: The KDE Frameworks
description: Providing everything from simple utility classes to ..
long_description: # optional, one item per paragraph, html authorized
- The KDE Frameworks build on the <a href="https://www.qt.io">Qt
framework</a>, providing everything from simple utility classes (such as
those in KCoreAddons) to integrated solutions for common requirements of
desktop applications (such as KNewStuff, for fetching downloadable add-on
content in an application, or the powerful KIO multi-protocol file access
subgroups: # every subgroup must be declared here or will be ignored
description: Tier 1 frameworks depend only on Qt (and possibly a small number of other third-party libraries), so can easily be used by an Qt-based project.
description: Tier 2 frameworks additionally depend on tier 1 frameworks, but still have easily manageable dependencies.