PolytreeDE/polybar
1
0
Fork 0
mirror of https://github.com/polybar/polybar.git synced 2024-10-27 05:23:39 -04:00
Code Releases Activity
A fast and easy-to-use status bar
1344 commits 7 branches 109 tags 14 MiB
C++ 94.6%
CMake 4.1%
Shell 1.1%
Python 0.1%
Vim Script 0.1%
Find a file
patrick96 b5129ae0c4 refactor(ccache): Enable by default 
Following [1] to get to this setup.

We setup all the ccache configuration before calling project() because
project will perform compiler checks. This is also why we can't use
message_colored here and print the colors manually

Before ENABLE_CCACHE was not yet defined when we reached the check in
01-core because the option was defined in 02-opts

[1] https://crascit.com/2016/04/09/using-ccache-with-cmake/
2018-06-01 10:49:00 -07:00
.hooks feat(git): Update old tag refs in README.md using pre-commit hook 2016-05-24 17:02:33 +02:00
cmake refactor(ccache): Enable by default 2018-06-01 10:49:00 -07:00
common fix(clang): Search for files in right places 2018-05-20 16:37:18 -07:00
contrib fix(aur): Backport gcc fix 2018-05-07 19:39:05 -07:00
doc Fix Color Hex Values 2018-05-22 17:01:18 -07:00
include feat(mpd): add support for MPD_TAG_ALBUM_ARTIST 2018-05-31 20:12:23 -07:00
lib fix(gcc): Fix -Wstringop-truncation warning 2018-05-06 14:17:10 -07:00
man build: Bump version to 3.0.2 2017-01-26 21:57:01 +01:00
src feat(mpd): add support for MPD_TAG_ALBUM_ARTIST 2018-05-31 20:12:23 -07:00
tests bar: Add geom_format_to_pixels tests 2018-05-10 00:05:18 +02:00
.clang-format clang-format: Increase column limit 2016-11-12 13:07:05 +01:00
.clang-tidy refactor(clang-tidy): Clean up .clang-tidy 2018-05-20 16:37:18 -07:00
.codecov.yml fix(codecov): Ignore lib folder for coverage 2018-05-06 14:30:34 -07:00
.editorconfig Add trim_trailing_whitespace to .editorconfig 2017-09-24 08:31:42 +02:00
.gitignore feat(build): Development tasks 2017-01-27 04:15:14 +01:00
.gitmodules git: Update submodule versions 2017-08-30 17:33:38 +02:00
.travis.yml feat(travis): switch to codecov for code coverage (#1165) 2018-04-16 20:03:34 +02:00
.valgrind-suppressions refactor(x11): Merge xlib/xutils with connection 2016-12-31 10:02:32 +01:00
.ycm_extra_conf.py fix(ycm): Use compilation db for all possible files 2018-04-08 02:30:04 +02:00
banner.png Add polybar banner 2018-05-27 09:37:56 +02:00
build.sh refactor(build.sh): Add gcc over clang option(#1249) 2018-05-20 10:30:33 +02:00
CMakeLists.txt refactor(ccache): Enable by default 2018-06-01 10:49:00 -07:00
LICENSE init(git): Base commit 2016-05-19 20:23:45 +02:00
Makefile feat(build): help target to list all targets (#870) 2017-11-30 21:42:11 +01:00
README.md fix(README): remove colon between name and username 2018-05-30 07:19:49 +02:00
SUPPORT.md Add SUPPORT.md (#803) 2017-10-28 23:17:46 +02:00

README.md

Polybar

Build Status Coverage Status MIT License

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

Polybar 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. Here are a few screenshots showing you what it can look like:

sample screenshot sample screenshot sample screenshot sample screenshot

If you need help, check out the Support page.

Please report any issues or bugs you may find by creating an issue ticket here on GitHub. Make sure you include steps on how to reproduce it. There's also an irc channel available at freenode, cleverly named #polybar.

Table of Contents

Introduction

The main purpose of Polybar is to help users create awesome status bars. It has built-in functionality to display information about the most commonly used services. Some of the services included so far:

  • Systray icons
  • Window title
  • Playback controls and status display for MPD using libmpdclient
  • ALSA volume controls
  • Workspace and desktop panel for bspwm and i3
  • Workspace module for EWMH compliant window managers
  • Keyboard layout and indicator status
  • 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
  • Inter-process messaging
  • And more...

See the wiki for more details.

Getting started

Packaging status

If you are using Arch Linux, you can install the AUR package polybar-git to get the latest version, or polybar for the latest stable release. If you create a package for any other distribution, please consider contributing the template.

If you are using Void Linux, you can install polybar using xbps-install -S polybar.

If you are using NixOS, polybar is available in both the stable and unstable channels and can be installed with the command nix-env -iA nixos.polybar.

If you are using Ubuntu, polybar is available from the GetDeb repository.

If you are using Slackware, polybar is available from the SlackBuilds repository.

If you are using Source Mage GNU/Linux, polybar spell is available in test grimoire and can be installed via cast polybar.

If you are using openSUSE, polybar is available from OBS repository. For now package is only for Tumbleweed.

If you are using FreeBSD, polybar can be installed using pkg install polybar. Make sure you are using the latest package branch.

If you are using Gentoo, both release and git-master versions are available in the main repository.

Dependencies

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

  • cairo
  • libxcb
  • python2
  • xcb-proto
  • xcb-util-image
  • xcb-util-wm
  • xcb-util-xrm

Optional dependencies:

  • xcb-util-cursor required for the cursor-click and cursor-scroll settings

Optional dependencies for extended module support:

  • alsa-lib required by internal/alsa
  • libpulse required by internal/pulseaudio
  • i3-wm required by internal/i3
  • jsoncpp required by internal/i3
  • libmpdclient required by internal/mpd
  • libcurl required by internal/github
  • wireless_tools required by internal/network

Find a more complete list on the dedicated wiki page.

Building from source

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

$ git clone --branch 3.1.0 --recursive https://github.com/jaagr/polybar
$ mkdir polybar/build
$ cd polybar/build
$ cmake ..
$ 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

$ polybar example

Running

See the wiki for details on how to run polybar.

Contributors

Owner

Maintainers

Logo Design by

All Contributors

License

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