emma/Wallman
emma/Wallman
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity

Add documentation for the notify option and adjust documentation for change from wallpaper_sets to general

Browse source
This commit is contained in:
Emma Nora Theuer 2024-05-28 22:36:48 +02:00
parent ef89547708
commit 58a3e1c46a
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.org
View file

@ -14,10 +14,14 @@ Wallman currently has three main features:
+ Settings Wallpapers at a specific time of the day + Settings Wallpapers at a specific time of the day
* Installation * Installation
** Requirements ** Depedencies
*** Alwaus Required
+ Python 3.11 or newer (Required because of tomllib) + Python 3.11 or newer (Required because of tomllib)
+ APScheduler (Install python-apscheduler or APScheduler, depending on the package manager) + APScheduler (Install python-apscheduler or APScheduler, depending on the package manager)
+ feh (Used for setting the wallpapers, hard dependency) + feh (Used for setting the wallpapers, hard dependency)
*** Optional
+ libnotify (for desktop notification support.)
** How to install it? ** How to install it?
+ Clone this git repo + Clone this git repo
@ -34,8 +38,8 @@ cp sample_config.toml ~/.config/wallman/wallman.toml
* Configuration * Configuration
This is a short guide on how to correctly configure wallman. Look in the sample config for additional context. This is a short guide on how to correctly configure wallman. Look in the sample config for additional context.
** TOML Dictionaries ** TOML Dictionaries
First of all, the config file is structured via different TOML dictionaries. There are two TOML dictionaries: wallpaper_sets and changing_times that must be present in every config. Aside from that, further dictionaries are needed depending on how wallman is configured. You need to create a dictionary with the name of each wallpaper set defined in the used_sets list (more on that later). You should probably just configure wallman by editing the sample config as it is by far the easiest way to do it. First of all, the config file is structured via different TOML dictionaries. There are two TOML dictionaries: general and changing_times that must be present in every config. Aside from that, further dictionaries are needed depending on how wallman is configured. You need to create a dictionary with the name of each wallpaper set defined in the used_sets list (more on that later). You should probably just configure wallman by editing the sample config as it is by far the easiest way to do it.
*** wallpaper_sets *** general
In wallpaper_sets, you need to always define 3 variables: In wallpaper_sets, you need to always define 3 variables:
+ enabled: bool + enabled: bool
A simple switch that states if you want to use different sets of wallpapers or not. A simple switch that states if you want to use different sets of wallpapers or not.
@ -43,6 +47,8 @@ In wallpaper_sets, you need to always define 3 variables:
A list that includes the names of the wallpaper sets you want to use. If you want to use only one, the list should have one entry. A list that includes the names of the wallpaper sets you want to use. If you want to use only one, the list should have one entry.
+ wallpapers_per_set: int + wallpapers_per_set: int
The amount of wallpapers that you use in each set. It should be an integer. The amount of wallpapers that you use in each set. It should be an integer.
+ Optional: notify: bool
This defaults to "false". Enable to set send a desktop notification when the wallpaper is changed. The program will still work correctly, even if this option is not defined at all.
*** changing_times *** changing_times
The changing_times dictionary is used to specify the times of the day when your wallpaper is switched. The names of the keys do not matter here, the values must always be strings in the "XX:YY:ZZ" 24 hour time system. use 00:00:00 for midnight. Note that XX should be in the range of 00-23 and YY and ZZ should be in the range of 00-59. The changing_times dictionary is used to specify the times of the day when your wallpaper is switched. The names of the keys do not matter here, the values must always be strings in the "XX:YY:ZZ" 24 hour time system. use 00:00:00 for midnight. Note that XX should be in the range of 00-23 and YY and ZZ should be in the range of 00-59.