Document that hyprlock config is required. (#928)

Without a config, hyprlock fails with:

```
[CRITICAL] ConfigManager threw: Could not find config in HOME, XDG_CONFIG_HOME, XDG_CONFIG_DIRS or /etc/hypr.
```

This was mentioned in https://github.com/hyprwm/hyprlock/issues/450 and closed with

>  hyprlock with no config is more confusing than anything, as it will not render anything

So I'm assuming this is behaving as expected and the docs just need to be fixed.
This commit is contained in:
Ryan Roden-Corrent 2025-01-04 11:39:24 -05:00 committed by GitHub
parent 74f9126dff
commit 0b98e91eea
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -8,8 +8,7 @@ for Hyprland.
## Configuration
Configuration is done via the config file at `~/.config/hypr/hyprlock.conf`. It
is not required, but recommended. Without it, locking shows the current screen.
Configuration is done via the config file at `~/.config/hypr/hyprlock.conf`. This file must exist to run `hyprlock`.
### Variable types