Rooba
/
polybar
mirror of https://github.com/polybar/polybar.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
A fast and easy-to-use status bar
521 Commits 7 Branches 109 Tags 18 MiB
C++ 94.6%
CMake 4.1%
Shell 1.1%
Python 0.1%
Vim Script 0.1%
Go to file
Michael Carlberg 04fac96d78 fix(mpd): Hide module on empty playlist 
Closes #149
 		2016-11-14 01:21:58 +01:00
.hooks feat(git): Update old tag refs in README.md using pre-commit hook 2016-05-24 17:02:33 +02:00
cmake wip: Inter-process messaging 2016-11-13 19:05:30 +01:00
contrib build: Bump version to 2.2.5 2016-11-12 13:55:06 +01:00
examples refactor(fs): Update naming to reflect actual usage 2016-11-13 08:50:14 +01:00
include fix(mpd): Hide module on empty playlist 2016-11-14 01:21:58 +01:00
lib git: Update xpp ref 2016-11-04 20:43:33 +01:00
man wip: Rewrite manpages for 2.0 2016-10-18 18:40:47 +02:00
src fix(mpd): Hide module on empty playlist 2016-11-14 01:21:58 +01:00
tests wip: Separate source from definitions 2016-11-03 12:54:32 +01:00
.clang-format clang-format: Increase column limit 2016-11-12 13:07:05 +01:00
.clang-tidy git: Add .clang-tidy rules 2016-10-28 12:40:53 +02:00
.exrc wip: Separate source from definitions 2016-11-03 12:54:32 +01:00
.gitignore feat(bspwm): added scrolling 2016-11-11 10:55:37 -08:00
.gitmodules git: Update xpp ref 2016-11-04 20:43:33 +01:00
.travis.yml fix(travis): Install xcb-util-image 2016-11-04 20:57:22 +01:00
.ycm_extra_conf.py refactor(eventloop): Use concurrent queue for events 2016-10-29 06:48:51 +02:00
CMakeLists.txt wip: Separate source from definitions 2016-11-03 12:54:32 +01:00
LICENSE init(git): Base commit 2016-05-19 20:23:45 +02:00
README.md build: Bump version to 2.2.5 2016-11-12 13:55:06 +01:00
build.sh feat(build.sh): Prompt for build options 2016-11-12 13:07:05 +01:00
bump.sh fix(bump.sh): Support multi digit patch versions 2016-10-29 19:49:00 +02:00
config fix(ci): Install i3-wm to build with i3 support 2016-10-12 11:36:59 +02:00
version.sh fix: Custom version by argument 2016-06-28 15:24:23 +02:00

README.md

Lemonbuddy

Build Status MIT License

A fast and easy-to-use tool for creating status bars.

Lemonbuddy aims to help users build beautiful and highly customizable status bars for their desktop environment, without the need of having a black belt in shell scripting. Heres a few screenshots showing you what it can look like:

sample screenshot sample screenshot sample screenshot sample screenshot

Please note that the project still is in early development, so please report any problems by creating an issue ticket.

Table of Contents

Introduction

The main purpose of Lemonbuddy is to help users create awesome status bars. It has built-in functionality to generate content for the most commonly used widgets, such as:

  • Playback controls and status display for MPD using libmpdclient
  • ALSA volume controls
  • Workspace and desktop panel for bspwm and i3
  • CPU and memory load indicator
  • Battery display
  • Network connection details
  • Backlight level
  • Date and time label
  • Time-based shell script execution
  • Command output tailing
  • User-defined menu tree
  • And more...

Each bar contains a set of modules, which in turn defines a set of formatting rules and options. Read more about how the configuration works.

Getting started

If you are using Arch Linux, you can install the AUR package lemonbuddy-git to get the latest version, or lemonbuddy for the latest stable release. If you are using Void Linux you can install the package lemonbuddy available in the official xbps repository.

If you create a package for any other distribution, please consider contributing the template.

Dependencies

A compiler with C++14 support (clang-3.4+, gcc-5.1+).

  • cmake
  • boost
  • xcb-util-wm
  • xcb-util-image
  • libXft
  • python2

Optional dependencies for module support:

  • jsoncpp (required by internal/i3)
    • Because some distributions only offer pre-historic releases of jsoncpp, a local copy of the library source (jsoncpp-1.7.7) will be built and linked statically as a fallback if a valid version is not found.
  • wireless_tools (required by internal/network)
  • alsa-lib (required by internal/volume)
  • libmpdclient (required by internal/mpd)
$ pacman -S cmake python2 boost xcb-util-image xcb-util-wm libxft wireless_tools alsa-lib libmpdclient
$ apt-get install cmake cmake-data libboost-dev libfreetype6-dev libxcb1-dev libx11-xcb-dev libxcb-util0-dev libxcb-image0-dev libxcb-randr0-dev libxcb-ewmh-dev libxcb-icccm4-dev xcb-proto python-xcbgen i3-wm libiw-dev libasound2-dev libmpdclient-dev

Building from source

Please report any problems you run into when building the project.

$ git clone --branch 2.2.5 --recursive https://github.com/jaagr/lemonbuddy
$ mkdir lemonbuddy/build
$ cd lemonbuddy/build
$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ sudo make install

There's also a helper script available in the root folder:

$ ./build.sh

Configuration

Details on how to setup and configure the bar and each module have been moved to the wiki.

# Install the example configuration
$ make userconfig
# Launch the example bar
$ lemonbuddy example

NOTE: If the bar output looks odd, it's probably because you're missing he fonts defined in the config. Update the config or install the missing fonts.

Running

See the wiki page on how to launch the bar when starting your WM.

License

Lemonbuddy is licensed under the MIT license. See LICENSE for more information.