further developed README
This commit is contained in:
parent
e6e7940fbb
commit
082ab949e4
1 changed files with 24 additions and 1 deletions
25
README.md
25
README.md
|
@ -1,8 +1,22 @@
|
|||
# easyconf-lemonbar (eclb)
|
||||
|
||||
A python script to easily configure lemonbar.
|
||||
A small python script to easily configure lemonbar. Uses a simple yaml file to
|
||||
declaratively define your custom bar, and includes useful features such as
|
||||
asynchronous refreshing and signal handling. Concept inspired by
|
||||
[UtkarshVerma/dwmblocks-async](https://github.com/UtkarshVerma/dwmblocks-async).
|
||||
|
||||
## Installation
|
||||
### Prerequisites
|
||||
- python3: a fairly recent version
|
||||
- lemonbar: your fork of choice
|
||||
- poetry: python package manager
|
||||
|
||||
This project uses [poetry](https://github.com/python-poetry/poetry) as the
|
||||
package manager. This will take care of the necessary python libraries and
|
||||
stuff. It should be available in your distro's package repos. Just make sure it
|
||||
is installed and the script will do the rest for you.
|
||||
|
||||
### Instructions
|
||||
To install the latest release:
|
||||
```sh
|
||||
git clone --depth 1 --branch latest https://git.noahsw.xyz/noah/easyconf-lemonbar.git
|
||||
|
@ -22,6 +36,13 @@ cp /usr/local/share/doc/easyconf-lemonbar/example_config.yml ${HOME}/.config/eas
|
|||
This example file is very heavily commented. Almost all the info you will need
|
||||
is contained in the file.
|
||||
|
||||
### Running
|
||||
Make sure `/usr/local/bin` is in your path (it should be by default) and run:
|
||||
|
||||
```sh
|
||||
easyconf-lemonbar &
|
||||
```
|
||||
|
||||
### Signals
|
||||
You may update individual modules by sending a real-time signal to the
|
||||
easyconf-lemonbar process. First, in the module configuration, specify which
|
||||
|
@ -33,6 +54,8 @@ signal to listen for, e.g.
|
|||
command: "python -c 'from random import randrange; print(randrange(1000))'"
|
||||
refresh: 0
|
||||
signal: 1
|
||||
format:
|
||||
align: left
|
||||
```
|
||||
|
||||
In the example above, the refresh is `0`. This means that the module *will never
|
||||
|
|
Loading…
Reference in a new issue