From 292c4454bd0db26e32c2805f7a0cc0e4b5af1d88 Mon Sep 17 00:00:00 2001 From: Bazyli Cyran Date: Sat, 14 Dec 2024 14:53:04 +0100 Subject: [PATCH] docs: Improve configuration description --- README.md | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b48a0f3..1e1842c 100644 --- a/README.md +++ b/README.md @@ -46,17 +46,10 @@ cargo install timewall ``` ## Usage -### Initial configuration -If you intend to use sun position based wallpapers, you need to provide `timewall` with your approximate location. -To do this, create a config file `$XDG_CONFIG_HOME/timewall/config.toml` (probably `~/.config/timewall/config.toml` if you're not sure). -This file will be also written when you first run `timewall set`. -Put the following contents in the file, while changing `lat` (latitude) and `lon` (longitude) values to your needs: -```toml -[location] -lat = 51.11 -lon = 17.02 -``` +### Initial configuration +If you intend to use sun position based wallpapers, you need to configure your geographical location. +See [Configuration](#geographical-location). ### Setting the wallpaper #### One-time mode @@ -128,6 +121,19 @@ timewall info path/to/wallpaper.heif ``` ### Configuration +`timewall` uses a config file at `$XDG_CONFIG_HOME/timewall/config.toml` (usually `~/.config/timewall/config.toml`). +A default config will be written when you first run `timewall set`. + +#### Geographical location +Using sun position based wallpapers requires your approximate geographical location. +This is configured as follows: +```toml +[location] +lat = 51.11 +lon = 17.02 +``` +Adjust the values `lat` (latitude) and `lon` (longitude) to your needs. + #### Custom wallpaper setting command If the default wallpaper setting doesn't work in your case for some reason, or you just want to customize it, you can specify custom command to use. For instance, to set the wallpaper using `feh`, you could add the following to your `~/.config/timewall/config.toml`: