hyprlock: warn about not rendering anything by default
Some checks are pending
Update Website / notify-parent-repo (push) Waiting to run

This commit is contained in:
Vaxry 2025-05-05 22:42:45 +01:00
parent dbf93bd553
commit 8dcd3cf21d
No known key found for this signature in database
GPG key ID: 665806380871D640

View file

@ -6,6 +6,16 @@ title: hyprlock
hyprlock is a simple, yet fast, multi-threaded and GPU-accelerated screen lock hyprlock is a simple, yet fast, multi-threaded and GPU-accelerated screen lock
for Hyprland. for Hyprland.
{{< callout type=warning >}}
Hyprlock does not automatically create a config, and without one, hyprlock will _not render anything_,
meaning you will just see your screen, but it will be locked and require a password followed by an
enter to unlock.
You can use the example config for a quick start, which can be found [here](https://github.com/hyprwm/hyprlock/blob/main/assets/example.conf).
{{< /callout >}}
## Configuration ## Configuration
Configuration is done via the config file at `~/.config/hypr/hyprlock.conf`. This file must exist to run `hyprlock`. Configuration is done via the config file at `~/.config/hypr/hyprlock.conf`. This file must exist to run `hyprlock`.