Waybar/README.md

# Waybar [![Travis](https://travis-ci.org/Alexays/Waybar.svg?branch=master)](https://travis-ci.org/Alexays/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/), [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)
- Tray [#21](https://github.com/Alexays/Waybar/issues/21)
- Local time
- Battery
- Network
- Pulseaudio
- Disk
- Memory
- Cpu load average
- Temperature
- MPD
- Custom scripts
- Multiple output configuration
- And much more customizations

**Configuration and Styling**

[See the wiki for more details](https://github.com/Alexays/Waybar/wiki).

**How to build**

```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
libinput

libsigc++
fmt
wayland
wlroots
libgtk-3-dev [gtk-layer-shell]
gobject-introspection [gtk-layer-shell]
libgirepository1.0-dev [gtk-layer-shell]
libpulse [Pulseaudio module]
libnl [Network module]
sway [Sway modules]
libdbusmenu-gtk3 [Tray module]
libmpdclient [MPD module]
```

On Ubuntu 19.10 you can install all the relevant dependencies using this command:

```
sudo apt install \
  clang-tidy \
  gobject-introspection \
  libdbusmenu-gtk3-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
```


Contributions welcome! - have fun :)<br>
The style guidelines is [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).
Update README.md 2019-02-04 09:32:16 +00:00			`# Waybar [![Travis](https://travis-ci.org/Alexays/Waybar.svg?branch=master)](https://travis-ci.org/Alexays/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)`
Update README.md 2018-08-08 21:58:43 +00:00
Update README.md 2018-08-10 10:28:54 +00:00			`> Highly customizable Wayland bar for Sway and Wlroots based compositors.<br>`
Note availability in Arch community repository 2019-03-27 01:20:09 +00:00			`> Available in Arch [community](https://www.archlinux.org/packages/community/x86_64/waybar/) or`
Add Alpine Linux to list of distros 2019-11-11 10:46:10 +00:00			`[AUR](https://aur.archlinux.org/packages/waybar-git/), [openSUSE](https://build.opensuse.org/package/show/X11:Wayland/waybar), and [Alpine Linux](https://pkgs.alpinelinux.org/packages?name=waybar)<br>`
Update README.md 2019-06-11 11:55:35 +00:00			`> Waybar [examples](https://github.com/Alexays/Waybar/wiki/Examples)`
chore(README): add preview 2018-08-08 22:06:10 +00:00
Update README.md 2018-08-08 21:58:43 +00:00			`Current features`
chore: update README 2018-11-16 09:06:24 +00:00			`- Sway (Workspaces, Binding mode, Focused window name)`
Update README.md 2019-04-16 11:42:49 +00:00			`- Tray [#21](https://github.com/Alexays/Waybar/issues/21)`
Update README.md 2018-08-08 21:58:43 +00:00			`- Local time`
			`- Battery`
Update README.md 2018-08-10 10:28:54 +00:00			`- Network`
chore(README): update preview 2018-08-09 21:57:11 +00:00			`- Pulseaudio`
chore: update README 2019-09-25 08:27:51 +00:00			`- Disk`
Update README.md 2018-08-10 10:28:54 +00:00			`- Memory`
			`- Cpu load average`
feat(temperature): update README 2019-03-13 15:56:13 +00:00			`- Temperature`
feat: Add basic support for MPD 2019-04-16 14:34:37 +00:00			`- MPD`
fix(README): typo 2018-08-10 14:29:37 +00:00			`- Custom scripts`
Update README.md 2019-02-01 20:52:38 +00:00			`- Multiple output configuration`
feat(workspaces): add urgent, visible class 2018-08-15 13:03:51 +00:00			`- And much more customizations`
Update README.md 2018-08-10 10:28:54 +00:00
Update README.md 2018-12-28 23:06:59 +00:00			`Configuration and Styling`
Update README.md 2018-08-08 21:58:43 +00:00
Update README.md 2018-08-10 10:28:54 +00:00			`[See the wiki for more details](https://github.com/Alexays/Waybar/wiki).`

			`How to build`
Update README.md 2018-08-09 12:00:08 +00:00
			```bash
Update README.md 2018-08-10 10:28:54 +00:00			`$ git clone https://github.com/Alexays/Waybar`
chore: update README 2018-11-16 09:07:20 +00:00			`$ cd Waybar`
Update README.md 2018-08-10 10:28:54 +00:00			`$ meson build`
			`$ ninja -C build`
			`$ ./build/waybar`
Update README.md 2018-12-28 23:06:59 +00:00			`# If you want to install it`
			`$ ninja -C build install`
			`$ waybar`
			```

			`Dependencies`

			```
			`gtkmm3`
			`jsoncpp`
			`libinput`
Update README.md 2019-06-11 11:55:35 +00:00
Update README.md 2018-12-28 23:06:59 +00:00			`libsigc++`
Add fmt dependency to README.md 2019-01-25 15:38:38 +00:00			`fmt`
Update README.md 2018-12-28 23:06:59 +00:00			`wayland`
			`wlroots`
add dependencies of gtk-layer-shell to readme 2019-12-28 14:19:42 +00:00			`libgtk-3-dev [gtk-layer-shell]`
			`gobject-introspection [gtk-layer-shell]`
			`libgirepository1.0-dev [gtk-layer-shell]`
Update README.md 2018-12-28 23:06:59 +00:00			`libpulse [Pulseaudio module]`
			`libnl [Network module]`
			`sway [Sway modules]`
			`libdbusmenu-gtk3 [Tray module]`
feat: Add basic support for MPD 2019-04-16 14:34:37 +00:00			`libmpdclient [MPD module]`
Update README.md 2018-08-09 12:00:08 +00:00			```

Provide easy bootstrap command for Ubuntu-users 2019-12-09 12:20:29 +00:00			`On Ubuntu 19.10 you can install all the relevant dependencies using this command:`

			```
readme: adding libspdlog-dev to list of ubuntu dependencies, also sorting and cleaning up list to make it easier to read and copy 2020-03-05 13:57:19 +00:00			`sudo apt install \`
			`clang-tidy \`
			`gobject-introspection \`
			`libdbusmenu-gtk3-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`
Provide easy bootstrap command for Ubuntu-users 2019-12-09 12:20:29 +00:00			```


chore: v0.0.4 2018-08-16 15:19:02 +00:00			`Contributions welcome! - have fun :)<br>`
Style code (#25) 2018-08-16 12:29:41 +00:00			`The style guidelines is [Google's](https://google.github.io/styleguide/cppguide.html)`
Update README.md 2018-08-10 10:28:54 +00:00
			`## License`

			`Waybar is licensed under the MIT license. [See LICENSE for more information](https://github.com/Alexays/Waybar/blob/master/LICENSE).`