pgrondek/polybar-dwm
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation update for 3.6

Browse Source
This commit is contained in:
patrick96 2022-03-02 14:36:54 +01:00 committed by Patrick Ziegler
parent 2322493ac8
commit 4350e356a7
4 changed files with 7 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -24,7 +24,7 @@ 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.
![sample screenshot](doc/_static/default.png)
![default configuration screenshot](doc/_static/default.png)
## Table of Contents
@ -33,8 +33,7 @@ for their desktop environment, without the need of having a black belt in shell
* [Contributing](#contributing)
* [Getting started](#getting-started)
* [Installation](#installation)
* [Configuration](#configuration)
* [Running](#running)
* [First Steps](#first-steps)
* [Community](#community)
* [Contributors](#contributors)
* [Donations](#donations)
@ -128,35 +127,8 @@ If you are using **Fedora**, you can install [polybar](https://src.fedoraproject
If you can't find your distro here, you will have to [build from source](https://github.com/polybar/polybar/wiki/Compiling).
### Configuration
Details on how to setup and configure the bar and each module have been moved to [the wiki](https://github.com/polybar/polybar/wiki/Configuration).
#### Install the example configuration
For a normal installation, polybar will install the example config to
`/usr/share/doc/polybar/config` or ` /usr/local/share/doc/polybar/config`
(depending on your install parameters)
From there you can copy it to `~/.config/polybar/config` to get started (make
sure to backup any existing config file there).
**Note:** This example file is meant to showcase available modules and
configuration options.
Running it as-is will work but many modules will likely not start because they
require machine-specific configuration and many of the font icons will not show
up because they require a very specific [font
configuration](https://github.com/polybar/polybar/wiki/Fonts).
We encourage you to use it as a reference when building
your own configuration.
#### Launch the example bar
~~~ sh
$ polybar example
~~~
### Running
[See the wiki for details on how to run polybar](https://github.com/polybar/polybar/wiki).
### First Steps
[See the wiki for details on how to run and configure polybar](https://github.com/polybar/polybar/wiki).
## Community
Want to get in touch?

2
cmake/01-core.cmake
View File

@ -15,7 +15,7 @@ option(BUILD_POLYBAR "Build the main polybar executable" ${DEFAULT_ON})
option(BUILD_POLYBAR_MSG "Build polybar-msg" ${DEFAULT_ON})
option(BUILD_TESTS "Build testsuite" OFF)
option(BUILD_DOC "Build documentation" ${DEFAULT_ON})
option(BUILD_CONFIG "Generate sample configuration" ${DEFAULT_ON})
option(BUILD_CONFIG "Generate default configuration" ${DEFAULT_ON})
option(BUILD_SHELL "Generate shell completion files" ${DEFAULT_ON})
include(CMakeDependentOption)

2
cmake/05-summary.cmake
View File

@ -26,7 +26,7 @@ colored_option(" testsuite" BUILD_TESTS)
colored_option(" documentation" BUILD_DOC)
colored_option(" html" BUILD_DOC_HTML)
colored_option(" man" BUILD_DOC_MAN)
colored_option(" sample config" BUILD_CONFIG)
colored_option(" default config" BUILD_CONFIG)
colored_option(" shell files" BUILD_SHELL)
if (BUILD_LIBPOLY)

2
doc/man/polybar.1.rst
View File

@ -8,7 +8,7 @@ SYNOPSIS
DESCRIPTION
-----------
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.
If the *BAR* argument is not provided and the configuration file only contains one bar definition, Polybar will display this bar.
If the *BAR* argument is not provided and the configuration file only contains one bar definition, polybar will display this bar.
OPTIONS
-------