README.md
1# wf-shell
2
3wf-shell is a repository which contains the various components needed to built a fully functional DE based around wayfire.
4Currently it has only a GTK-based panel and background client.
5
6# Dependencies
7
8wf-shell needs the core wayland libraries and protocols (`wayland-devel` and `wayland-protocols-devel` for Fedora), gtkmm-3.0 and [wf-config](https://github.com/WayfireWM/wf-config)
9
10# Build
11
12Just like any meson project:
13```
14git clone https://github.com/WayfireWM/wf-shell && cd wf-shell
15meson build --prefix=/usr --buildtype=release
16ninja -C build && sudo ninja -C build install
17```
18
19# Configuration
20
21To configure the panel and the dock, wf-shell uses a config file located (by default) in `~/.config/wf-shell.ini`
22An example configuration can be found in the file `wf-shell.ini.example`, alongside with comments what each option does.
23
24# Screenshots
25
26![Panel & Background demo](/screenshot.png)
27