herbe/README.md

39 lines
1.4 KiB
Markdown
Raw Normal View History

2020-07-30 18:51:34 +02:00
# 🌱 herbe
2020-08-04 06:19:12 +02:00
> Daemon-less notifications without D-Bus. Minimal and lightweight.
2020-08-08 18:10:39 +02:00
2020-08-08 18:10:20 +02:00
![herbe](https://raw.githubusercontent.com/dudik/herbe/master/herbe.png)
2020-07-30 18:51:34 +02:00
## Usage
```shell
2020-08-08 18:10:20 +02:00
herbe "herbe notifications" " " "Daemon-less notifications without D-Bus. Minimal and lightweight."
2020-07-30 18:51:34 +02:00
```
2020-08-08 18:10:20 +02:00
will display the notification shown above
2020-08-04 06:19:12 +02:00
2020-07-30 18:51:34 +02:00
## Installation
### Dependencies
* X11 (Xlib)
* Xft
* freetype2
The names of packages are different depending on which distribution you use.
For example, if you use [Void Linux](https://voidlinux.org/) you will have to install these dependencies:
```shell
sudo xbps-install base-devel libX11-devel libXft-devel
```
### Build
```shell
git clone https://github.com/dudik/herbe
cd herbe
sudo make install
```
`make install` requires root privileges because it copies the resulting binary to `/usr/local/bin`. This makes `herbe` accessible globally.
You can also use `make clean` to remove the binary from the build folder, `sudo make uninstall` to remove the binary from `/usr/local/bin` or just `make` to build the binary locally.
## Configuration
herbe is configured at compile-time by editing `config.h`. Every option should be self-explanatory. There is no `height` option because height is determined by font size and text padding.
## Contribute
If you want to report a bug or you have a feature request, feel free to [open an issue](https://github.com/dudik/herbe/issues).