1# Wapanel
2Simple panel/status bar/task bar for your custom *stacking* Wayland-based desktop.
3Documentation: https://firstbober.github.io/wapanel
4
5<img src="/resources/wapa-logo-color.svg?raw=true" width="100" height="100">
6
7## Features
8- Good configurability
9- Config hot reload
10- Exposed API for writing custom applets
11- Custom themes with CSS
12
13## Built-in applets
14- Activator
15- App finder (or menu start)
16- Clock
17- Separator
18- Task switcher
19- Volume control
20
21## Screenshot
22
23<img src="/wapanel-example.webp?raw=true" width="640">
24
25## Maintaining
26I will be trying to fix incoming issues in issue tracker but not add new features, if you want some upstream then pull request are open.
27
28## Packaging status
29
30### Fedora
31
32Available in official [repo](https://src.fedoraproject.org/rpms/wapanel).
33
34```
35sudo dnf install wapanel
36```
37
38## Building
39### Dependencies
40- Meson *
41- C/C++ compiler *
42- gtk-layer-shell (if not found, will be build automatically)
43- GTK+ 3
44- wayland-protocols
45- wayland-client
46- wayland-scanner *
47- libpulse
48- xdg-utils
49- pkg-config *
50
51Asterisk indicates compile-time dependencies.
52
53### Cloning
54```sh
55git clone --recurse-submodules https://github.com/Firstbober/wapanel.git
56```
57
58### Compiling and installation
59```sh
60mkdir build
61cd build
62meson .. # "meson .. -Dbuildtype=release" for release build
63sudo ninja install
64```
65
66If you want to not build some applets then use toggle -Dname=false. List of them is in meson_options.txt e.g. -Dactivator=false. This will disable building of an activator applet.
67
68## Contribute
69- Issue Tracker: https://github.com/Firstbober/wapanel/issues
70- Source Code: https://github.com/Firstbober/wapanel
71
72## License
73The project is licensed under the MIT license.
74