mirror of
https://github.com/rad4day/Waybar.git
synced 2023-12-21 10:22:59 +01:00
124 lines
3.1 KiB
Markdown
124 lines
3.1 KiB
Markdown
# Waybar [![Licence](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) [![Paypal Donate](https://img.shields.io/badge/Donate-Paypal-2244dd.svg)](https://paypal.me/ARouillard)<br>![Waybar](https://raw.githubusercontent.com/alexays/waybar/master/preview-2.png)
|
|
|
|
> Highly customizable Wayland bar for Sway and Wlroots based compositors.<br>
|
|
> Available in Arch [community](https://www.archlinux.org/packages/community/x86_64/waybar/) or
|
|
[AUR](https://aur.archlinux.org/packages/waybar-git/), [Gentoo](https://packages.gentoo.org/packages/gui-apps/waybar), [openSUSE](https://build.opensuse.org/package/show/X11:Wayland/waybar), and [Alpine Linux](https://pkgs.alpinelinux.org/packages?name=waybar).<br>
|
|
> *Waybar [examples](https://github.com/Alexays/Waybar/wiki/Examples)*
|
|
|
|
#### Current features
|
|
- Sway (Workspaces, Binding mode, Focused window name)
|
|
- River (Mapping mode, Tags, Focused window name)
|
|
- Hyprland (Focused window name)
|
|
- Tray [#21](https://github.com/Alexays/Waybar/issues/21)
|
|
- Local time
|
|
- Battery
|
|
- UPower
|
|
- Network
|
|
- Bluetooth
|
|
- Pulseaudio
|
|
- Wireplumber
|
|
- Disk
|
|
- Memory
|
|
- Cpu load average
|
|
- Temperature
|
|
- MPD
|
|
- Custom scripts
|
|
- Custom image
|
|
- Multiple output configuration
|
|
- And many more customizations
|
|
|
|
#### Configuration and Styling
|
|
|
|
[See the wiki for more details](https://github.com/Alexays/Waybar/wiki).
|
|
|
|
### Installation
|
|
|
|
Waybar is available from a number of Linux distributions:
|
|
|
|
[![Packaging status](https://repology.org/badge/vertical-allrepos/waybar.svg)](https://repology.org/project/waybar/versions)
|
|
|
|
An Ubuntu PPA with more recent versions is available
|
|
[here](https://launchpad.net/~nschloe/+archive/ubuntu/waybar).
|
|
|
|
|
|
#### Building from source
|
|
|
|
```bash
|
|
$ git clone https://github.com/Alexays/Waybar
|
|
$ cd Waybar
|
|
$ meson build
|
|
$ ninja -C build
|
|
$ ./build/waybar
|
|
# If you want to install it
|
|
$ ninja -C build install
|
|
$ waybar
|
|
```
|
|
|
|
**Dependencies**
|
|
|
|
```
|
|
gtkmm3
|
|
jsoncpp
|
|
libsigc++
|
|
fmt
|
|
wayland
|
|
chrono-date
|
|
spdlog
|
|
libgtk-3-dev [gtk-layer-shell]
|
|
gobject-introspection [gtk-layer-shell]
|
|
libgirepository1.0-dev [gtk-layer-shell]
|
|
libpulse [Pulseaudio module]
|
|
libnl [Network module]
|
|
libappindicator-gtk3 [Tray module]
|
|
libdbusmenu-gtk3 [Tray module]
|
|
libmpdclient [MPD module]
|
|
libsndio [sndio module]
|
|
libevdev [KeyboardState module]
|
|
xkbregistry
|
|
upower [UPower battery module]
|
|
```
|
|
|
|
**Build dependencies**
|
|
|
|
```
|
|
cmake
|
|
meson
|
|
scdoc
|
|
wayland-protocols
|
|
```
|
|
|
|
On Ubuntu, you can install all the relevant dependencies using this command (tested with 19.10 and 20.04):
|
|
|
|
```
|
|
sudo apt install \
|
|
clang-tidy \
|
|
gobject-introspection \
|
|
libdbusmenu-gtk3-dev \
|
|
libevdev-dev \
|
|
libfmt-dev \
|
|
libgirepository1.0-dev \
|
|
libgtk-3-dev \
|
|
libgtkmm-3.0-dev \
|
|
libinput-dev \
|
|
libjsoncpp-dev \
|
|
libmpdclient-dev \
|
|
libnl-3-dev \
|
|
libnl-genl-3-dev \
|
|
libpulse-dev \
|
|
libsigc++-2.0-dev \
|
|
libspdlog-dev \
|
|
libwayland-dev \
|
|
scdoc \
|
|
upower \
|
|
libxkbregistry-dev
|
|
```
|
|
|
|
|
|
Contributions welcome!<br>
|
|
Have fun :)<br>
|
|
The style guidelines are [Google's](https://google.github.io/styleguide/cppguide.html)
|
|
|
|
## License
|
|
|
|
Waybar is licensed under the MIT license. [See LICENSE for more information](https://github.com/Alexays/Waybar/blob/master/LICENSE).
|