plasma/sddm-kcm/README.md

0001 # sddm-kcm - Login Screen (SDDM) System Settings Module
0002
0003 `sddm-kcm` is a KConfig Module (KCM) that integrates itself into KDE's System Settings and serves the purpose of configuring the Simple Desktop Display Manager (SDDM) - the recommended display manager for KDE Plasma.
0004
0005 The main features are the selection of an SDDM theme and setting/modifying its wallpaper. The KCM also supports KDE's Get Hot New Stuff (GHNS) feature, which  means it is possible to install (and remove) user-created SDDM themes hosted on [the KDE Store](https://store.kde.org/browse/cat/101/).
0006
0007 The remainder of the options is geared towards affecting the login screen's behavior, such as enabling or disabling auto-login or setting the default session.
0008
0009 Certain visual and behavioral discrepancies between the login screen and the desktop — which may present themselves due to the login screen's inability to access user files — can be alleviated with the use of the settings synchronization feature. The feature currently allows users to sync the Plasma color scheme, cursor theme, font, font rendering, NumLock preference, Plasma theme, and scaling DPI.
0010
0011 # Installation
0012
0013 Most of the time your distribution should already include this settings module. If it doesn't, the module should exist as an installable standalone `sddm-kcm` package.
0014
0015 ## Dependencies
0016 * Qt5
0017 * CMake (with extra modules)
0018 * SDDM
0019 * KDE Frameworks 5
0020
0021 ## Compiling from source
0022 Installing system-wide:
0023
0024 ```
0025 git clone https://anongit.kde.org/sddm-kcm.git
0026 cd sddm-kcm
0027 mkdir build && cd build
0028 cmake .. \
0029     -DCMAKE_BUILD_TYPE=Release \
0030     -DCMAKE_INSTALL_PREFIX=/usr
0031 make
0032 sudo make install
0033 ```
0034
0035 # Support
0036 ## Reporting bugs
0037 Bugs should be reported to the KDE bug tracking system:
0038
0039 * https://bugs.kde.org/ (product `systemsettings`, component `sddm-kcm`)
0040
0041 The following community page can help explain the bug reporting process:
0042
0043 * https://community.kde.org/Get_Involved/Issue_Reporting
0044
0045 ## Contributing
0046 Developers are appreciative of potential contributions and will gladly help out with them. For contributors new to KDE there are guidelines which may be of assistance:
0047
0048 * https://community.kde.org/Get_Involved/development
0049
0050 If there is something you would like to discuss, you can either use [the main KDE developer mailing list](plasma-devel@kde.org) or contact the community via instant messaging. The most appropriate groups would be #plasma or #kde-vdg.
0051
0052 ## End user
0053 Some distributions use their own SDDM themes. If it's evident that a particular issue with the login screen stems from the theme please contact the support channels of your Linux distribution for user support.