README.md

   1 # 🌱 herbe
   2 > Daemon-less notifications without D-Bus. Minimal and lightweight.
   3 ![herbe](https://raw.githubusercontent.com/dudik/herbe/master/herbe.png)
   4
   5 ## Usage
   6 ```shell
   7 herbe "herbe notifications" " " "Daemon-less notifications without D-Bus. Minimal and lightweight."
   8 ```
   9 will display the notification shown above
  10
  11 ## Installation
  12 ### Dependencies
  13 * X11 (Xlib)
  14 * Xft
  15 * freetype2
  16
  17 The names of packages are different depending on which distribution you use.
  18 For example, if you use [Void Linux](https://voidlinux.org/) you will have to install these dependencies:
  19 ```shell
  20 sudo xbps-install base-devel libX11-devel libXft-devel
  21 ```
  22
  23 ### Build
  24 ```shell
  25 git clone https://github.com/dudik/herbe
  26 cd herbe
  27 sudo make install
  28 ```
  29 `make install` requires root privileges because it copies the resulting binary to `/usr/local/bin`. This makes `herbe` accessible globally.
  30
  31 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.
  32
  33 ## Configuration
  34 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.
  35
  36 ## Contribute
  37 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).