docs: update README

This commit is contained in:
Sebin Nyshkim 2022-09-16 18:07:36 +02:00
parent fe547014bd
commit 469f4cd042

View file

@ -24,26 +24,32 @@ To build the dynamic wallpaper packages simply clone this repository and run:
makepkg -s
~~~
Then install the package for your desktop.
Then install the package for your desktop:
~~~bash
# GNOME
pacman -U sebin-dynamic-wallpaper-1*.pkg.tar.zst
# KDE Plasma (⚠️ NOTE: the KDE Plasma version has a dependency to an AUR package, consider using an AUR helper, e.g. yay)
# KDE Plasma
# ⚠️ NOTE: the KDE Plasma version has a dependency to an AUR package: plasma5-wallpapers-dynamic
# Consider using an AUR helper, e.g. yay
pacman -U sebin-dynamic-wallpaper-kde-*.pkg.tar.zst
~~~
The wallpaper should show up in your desktop's wallpaper settings. Select it and enjoy a different wallpaper at different times throughout the day ✨
The wallpaper should show up in your desktop's wallpaper settings.
For KDE you need to switch the wallpaper type to "Dynamic" to use it with the dynamic wallpaper plugin.
Select it and enjoy a different wallpaper at different times throughout the day ✨
### Manual (every other distro)
#### GNOME
Clone this repository and copy the files to either
Clone this repository and copy the files to either:
* `~/.local/share/backgrounds/` (single user)
* `/usr/share/backgrounds/sebin-dynamic-wallpaper/` (system-wide):
* `/usr/share/backgrounds/sebin-dynamic-wallpaper/` (system-wide)
~~~bash
# single user
@ -57,23 +63,33 @@ sudo cp sebin.xml /usr/share/gnome-background-properties/
#### KDE Plasma
Install the [Plasma Dynamic Wallpaper Engine](https://github.com/zzag/plasma5-wallpapers-dynamic), clone this repository and build the AVIF file
For KDE the [Plasma Dynamic Wallpaper Engine](https://github.com/zzag/plasma5-wallpapers-dynamic) is required for this wallpaper to work.
Clone this repository and build the AVIF file:
~~~bash
kdynamicwallpaperbuilder "sebin-kdynamicwallpaperbuilder.json" --output "sebin-dyn_wallpaper.avif" --speed 10
kdynamicwallpaperbuilder "sebin-kdynamicwallpaperbuilder.json" --output "3840x2160.avif" --speed 10
~~~
Then copy it to either
Then copy files to either of these locations:
* `~/.local/share/backgrounds/` (single user)
* `/usr/share/backgrounds/sebin-dynamic-wallpaper-kde/` (system-wide):
* `~/.local/share/wallpapers/` (single user)
* `/usr/share/wallpapers/sebin-dynamic-wallpaper-kde/` (system-wide)
~~~bash
# single user
cp sebin-dyn_wallpaper.avif ~/.local/share/backgrounds/sebin-dynamic-wallpaper-kde/
mkdir -p ~/.local/share/wallpapers/sebin-dynamic-wallpaper-kde/contents/images
cp metadata.desktop ~/.local/share/wallpapers/sebin-dynamic-wallpaper-kde/metadata.desktop
cp screenshot.jpg ~/.local/share/wallpapers/sebin-dynamic-wallpaper-kde/contents/screenshot.jpg
cp 3840x2160.avif ~/.local/share/wallpapers/sebin-dynamic-wallpaper-kde/contents/images/3840x2160.avif
# system-wide
sudo cp sebin-dyn_wallpaper.avif /usr/share/backgrounds/sebin-dynamic-wallpaper-kde/
sudo mkdir -p /usr/share/wallpapers/sebin-dynamic-wallpaper-kde/contents/images
sudo cp metadata.desktop /usr/share/wallpapers/sebin-dynamic-wallpaper-kde/metadata.desktop
sudo cp screenshot.jpg /usr/share/wallpapers/sebin-dynamic-wallpaper-kde/contents/screenshot.jpg
sudo cp 3840x2160.avif /usr/share/wallpapers/sebin-dynamic-wallpaper-kde/contents/images/3840x2160.avif
~~~
### macOS