README.md
1# wlogout
2
3> wlogout is a logout menu for [wayland](https://wayland.freedesktop.org/) environments
4## Running
5Run `wlogout` to launch and press `Escape` to exit.
6## Config
7If you editing the default layout and css file it is recommended that you copy `/etc/wlogout/layout` and `/etc/wlogout/style.css` to `~/.config/wlogout/` and change them there.
8### Layout
9Custom buttons can be defined and edited in a layout file. The format is as follows:
10```
11{
12 "label" : "CSS Label",
13 "action" : "command to execute when clicked",
14 "text" : "text displayed on button",
15 "keybind" : "character to be bound"
16}
17```
18Check the default [layout file](layout) for examples and run `man 5 wlogout` for documentation.
19### Style
20wlogout can be easily styled through the style.css file; If you would like to style a button use the label given to it in the layout file, and for other styling refer to the [GTK Manual](https://developer.gnome.org/gtk3/stable/chap-css-properties.html) which shows all the allowed css.
21## Install
22### archlinux
23Arch users can use [wlogout](https://aur.archlinux.org/packages/wlogout/)
24```
25yay -S wlogout
26```
27### Compiling from Source
28Install dependencies:
29* GTK+
30* GObject introspection
31* meson
32* gtk-layer-shell (optional: transperancy)
33* scdoc (optional: man pages)
34* systemd (optional: default buttons)
35* swaylock (optional: default buttons)
36
37Run these commands:
38```
39git clone https://github.com/ArtsyMacaw/wlogout.git
40cd wlogout
41meson build
42ninja -C build
43sudo ninja -C build install
44```
45## License
46Wlogout is licensed under MIT. [Refer to LICENSE for more information](LICENSE)
47
