README.md

   1 # 🌱 herbe
   2 > Daemon-less notifications without D-Bus. Minimal and lightweight.
   3
   4 ## Usage
   5 ```shell
   6 herbe "This is a notification"
   7 ```
   8 will display a notification for the duration set in `config.h` that says `This is a notification`
   9
  10 ## TODO
  11 herbe is still a WIP.
  12 * Title support
  13 * Refactor code, it is not very readable
  14
  15 Not really sure about these, are they minimal, will someone use them?
  16 * Line breaks formatting
  17 * Icon/image support
  18 * Command-line options (change settings)
  19
  20 ## Installation
  21 ### Dependencies
  22 * X11 (Xlib)
  23 * Xft
  24 * freetype2
  25
  26 The names of packages are different depending on which distribution you use.
  27 For example, if you use [Void Linux](https://voidlinux.org/) you will have to install these dependencies:
  28 ```shell
  29 sudo xbps-install base-devel libX11-devel libXft-devel
  30 ```
  31
  32 ### Build
  33 ```shell
  34 git clone https://github.com/dudik/herbe
  35 cd herbe
  36 sudo make install
  37 ```
  38 `make install` requires root privileges because it copies the resulting binary to `/usr/local/bin`. This makes `herbe` accessible globally.
  39
  40 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.
  41
  42 ## Configuration
  43 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.
  44
  45 ## Contribute
  46 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).