summaryrefslogtreecommitdiffstats
path: root/desktop/gtklock-userinfo-module/README
diff options
context:
space:
mode:
Diffstat (limited to 'desktop/gtklock-userinfo-module/README')
-rw-r--r--desktop/gtklock-userinfo-module/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/desktop/gtklock-userinfo-module/README b/desktop/gtklock-userinfo-module/README
new file mode 100644
index 0000000000..5a44a570bf
--- /dev/null
+++ b/desktop/gtklock-userinfo-module/README
@@ -0,0 +1,11 @@
+gtklock-userinfo-module (adding user info to the lockscreen)
+
+gtklock is a lockscreen based on gtkgreet. It uses the
+wlr-layer-shell and wlr-input-inhibitor Wayland protocols. Works on
+sway and other wlroots-based compositors.
+
+NOTE:
+This modules user defined display is configured by the 'mugshot'
+application. Change any personal information or icon file within
+'mugshot' first in order for the gtklock module to show that info
+on the lockscreen.