diff --git a/src/branding/README.md b/src/branding/README.md index 7a3b4ad30..eefc7450a 100644 --- a/src/branding/README.md +++ b/src/branding/README.md @@ -2,4 +2,6 @@ Branding components go here. -A branding component is a subdirectory with a branding.desc descriptor file, containing brand-specific strings in a key-value structure, plus brand-specific images. Such a subdirectory, when placed here, is automatically picked up by CMake and made available to Calamares. +A branding component is a subdirectory with a branding.desc descriptor file, containing brand-specific strings in a key-value structure, plus brand-specific images or QML. Such a subdirectory, when placed here, is automatically picked up by CMake and made available to Calamares. + +QML files in a branding component can be translated. Translations should be placed in a subdirectory `lang` of the branding component directory. Qt translation files are supported (`.ts` sources which get compiled into `.qm`). Inside the `lang` subdirectory all translation files must be named according to the scheme `calamares-_.qm`.