README.md
1# swaybg
2
3swaybg is a wallpaper utility for Wayland compositors. It is compatible with any
4Wayland compositor which implements the following Wayland protocols:
5
6- wlr-layer-shell
7- xdg-output
8- xdg-shell
9
10See the man page, `swaybg(1)`, for instructions on using swaybg.
11
12## Release Signatures
13
14Releases are signed with [E88F5E48](https://keys.openpgp.org/search?q=34FF9526CFEF0E97A340E2E40FDE7BE0E88F5E48)
15and published [on GitHub](https://github.com/swaywm/swaybg/releases). swaybg
16releases are managed independently of sway releases.
17
18## Installation
19
20### From Packages
21
22swaybg is available in many distributions. Try installing the "swaybg"
23package for yours.
24
25If you're interested in packaging swaybg for your distribution, stop by the
26IRC channel or shoot an email to sir@cmpwn.com for advice.
27
28### Compiling from Source
29
30Install dependencies:
31
32* meson \*
33* wayland
34* wayland-protocols \*
35* cairo
36* gdk-pixbuf2 (optional: image formats other than PNG)
37* [scdoc](https://git.sr.ht/~sircmpwn/scdoc) (optional: man pages) \*
38* git (optional: version information) \*
39
40_\* Compile-time dep_
41
42Run these commands:
43
44 meson build/
45 ninja -C build/
46 sudo ninja -C build/ install
47