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

docs: Update README

Browse Source
This commit is contained in:
Michael Carlberg 2016-11-12 13:54:27 +01:00
parent 42bcfd9fa1
commit 03b6e1197e
1 changed files with 13 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -53,10 +53,10 @@ Read more about [how the configuration works](#configuration).
## Getting started ## Getting started
If you are using **Arch Linux**, you can install the AUR package [lemonbuddy-git](https://aur.archlinux.org/packages/lemonbuddy-git/) to get the latest version, or If you are using **Arch Linux**, you can install the AUR package [lemonbuddy-git](https://aur.archlinux.org/packages/lemonbuddy-git/) to get the latest version, or
[lemonbuddy](https://aur.archlinux.org/packages/lemonbuddy/) for the latest stable release. [lemonbuddy](https://aur.archlinux.org/packages/lemonbuddy/) for the latest stable release. If you are using **Void Linux**
you can install the package [lemonbuddy](https://github.com/voidlinux/void-packages/blob/master/srcpkgs/lemonbuddy/template) available in the official xbps repository.
If you create a package for any other distribution, please consider contributing the template so that we can make the application If you create a package for any other distribution, please consider contributing the template.
available for more people.
### Dependencies ### Dependencies
@ -97,26 +97,21 @@ Please [report any problems](https://github.com/jaagr/lemonbuddy/issues/new) you
$ sudo make install $ sudo make install
~~~ ~~~
There's also a helper script available in the root folder:
~~~ sh
$ ./build.sh
~~~
### Configuration ### Configuration
*Details on how to setup and configure the bar and each module have been moved to [the wiki](https://github.com/jaagr/lemonbuddy/wiki/Configuration).* Details on how to setup and configure the bar and each module have been moved to [the wiki](https://github.com/jaagr/lemonbuddy/wiki/Configuration).
Before customizing the bar, make sure everything works as expected by trying
out one of the example configurations installed with the application.
The following code will get you started:
~~~ sh ~~~ sh
# Create the config root directory # Install the example configuration
$ mkdir -p ${XDG_CONFIG_HOME:-$HOME/.config}/lemonbuddy $ make userconfig
$ cd ${XDG_CONFIG_HOME:-$HOME/.config}/lemonbuddy # Launch the example bar
# Copy sample config for the running wm (uses a wm agnostic config as fallback)
$ __wm=$(pgrep -l -x "(bspwm|i3)"); __prefix=$(which lemonbuddy)
$ cp "${__prefix%%/bin*}/share/examples/lemonbuddy/config${__wm:+.${__wm##* }}" config
# Launch the bar
# (where "example" is the name of the bar as defined by [bar/NAME] in the config)
$ lemonbuddy example $ lemonbuddy example
~~~ ~~~