Update README.md

This commit is contained in:
Samuel Dudík 2020-07-30 18:51:34 +02:00 committed by GitHub
parent ff740e689f
commit f22875d19b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,2 +1,36 @@
# herbe
> Daemon-less notifications wihout D-Bus
# 🌱 herbe
**Daemon-less notifications without D-Bus**
## Usage
```shell
herbe "This is a notification"
```
will display a notification for the duration set in `config.h` that says `This is a notification`
## 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).