Compare commits
10 Commits
8b455d4ced
...
dec89e4d66
| Author | SHA1 | Date |
|---|---|---|
|
|
dec89e4d66 | |
|
|
da58d3afbd | |
|
|
a773e568e5 | |
|
|
e2091908a9 | |
|
|
33ae07423d | |
|
|
75f2bf4b3f | |
|
|
829210456e | |
|
|
2e6dd07f36 | |
|
|
c30d3081e0 | |
|
|
acd72dd083 |
44
README.md
44
README.md
|
|
@ -5,13 +5,38 @@
|
||||||
<img src="https://user-images.githubusercontent.com/24730635/90975811-cd62fd00-e537-11ea-9169-92e68a71d0a0.gif" />
|
<img src="https://user-images.githubusercontent.com/24730635/90975811-cd62fd00-e537-11ea-9169-92e68a71d0a0.gif" />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## Usage
|
## Features
|
||||||
|
* Under 200 lines of code
|
||||||
|
* Doesn't run in the background, just displays the notification and exits
|
||||||
|
* No external dependencies except Xlib and Xft
|
||||||
|
* Configurable through `config.h` or Xresources ([using this patch](https://github.com/dudik/herbe/pull/11))
|
||||||
|
* [Actions support](#actions)
|
||||||
|
* Extensible through [patches](https://github.com/dudik/herbe/pulls?q=is%3Aopen+is%3Apr+label%3Apatch)
|
||||||
|
|
||||||
|
## Table of contents
|
||||||
|
|
||||||
|
* [Usage](#usage)
|
||||||
|
* [Patches](#patches)
|
||||||
* [Dismiss a notification](#dismiss-a-notification)
|
* [Dismiss a notification](#dismiss-a-notification)
|
||||||
* [Actions](#actions)
|
* [Actions](#actions)
|
||||||
* [Newlines](#newlines)
|
* [Newlines](#newlines)
|
||||||
* [Multiple notifications](#multiple-notifications)
|
* [Multiple notifications](#multiple-notifications)
|
||||||
* [Notifications don't show up](#notifications-dont-show-up)
|
* [Notifications don't show up](#notifications-dont-show-up)
|
||||||
|
* [Installation](#installation)
|
||||||
|
* [Packages](#packages)
|
||||||
|
* [Dependencies](#dependencies)
|
||||||
|
* [Build](#build)
|
||||||
|
* [Configuration](#configuration)
|
||||||
|
* [Contribute](#contribute)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Patches
|
||||||
|
[List of available patches](https://github.com/dudik/herbe/pulls?q=is%3Aopen+is%3Apr+label%3Apatch)
|
||||||
|
|
||||||
|
To create a new patch you'll have to open a pull request with your changes. Append `.diff` to the pull request URL to get a downloadable diff file. Don't forget to prefix the title with `patch:` and to apply the `patch` label to it. For inspiration, look at [my Xresources patch](https://github.com/dudik/herbe/pull/11). Thank you.
|
||||||
|
|
||||||
|
_Note: This patching method was heavily inspired by [dylan's sowm](https://github.com/dylanaraps/sowm)._
|
||||||
|
|
||||||
### Dismiss a notification
|
### Dismiss a notification
|
||||||
A notification can be dismissed either by clicking on it with `DISMISS_BUTTON` (set in config.h, defaults to left mouse button) or sending a `SIGUSR1` signal to it:
|
A notification can be dismissed either by clicking on it with `DISMISS_BUTTON` (set in config.h, defaults to left mouse button) or sending a `SIGUSR1` signal to it:
|
||||||
|
|
@ -71,10 +96,20 @@ $ pkill -SIGUSR2 herbe
|
||||||
And you should be fine. That's all you really need to interact with `herbe`.
|
And you should be fine. That's all you really need to interact with `herbe`.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
### Packages
|
||||||
|
[](https://repology.org/project/herbe/versions)
|
||||||
|
|
||||||
|
[OpenBSD patch](https://github.com/dudik/herbe/pull/4)
|
||||||
|
|
||||||
|
[FreeBSD patch](https://github.com/dudik/herbe/pull/16)
|
||||||
|
|
||||||
|
[Wayland port](https://github.com/muevoid/Wayherb) by [muevoid](https://github.com/muevoid)
|
||||||
|
|
||||||
|
**Only the [herbe-git AUR package](https://aur.archlinux.org/packages/herbe-git/) is maintained by me.**
|
||||||
|
|
||||||
### Dependencies
|
### Dependencies
|
||||||
* X11 (Xlib)
|
* X11 (Xlib)
|
||||||
* Xft
|
* Xft
|
||||||
* freetype2
|
|
||||||
|
|
||||||
The names of packages are different depending on which distribution you use.
|
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:
|
For example, if you use [Void Linux](https://voidlinux.org/) you will have to install these dependencies:
|
||||||
|
|
@ -95,5 +130,10 @@ You can also use `make clean` to remove the binary from the build folder, `sudo
|
||||||
## Configuration
|
## 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.
|
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.
|
||||||
|
|
||||||
|
[Xresources patch](https://github.com/dudik/herbe/pull/11)
|
||||||
|
|
||||||
## Contribute
|
## 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).
|
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).
|
||||||
|
|
||||||
|
## Projects with herbe integration
|
||||||
|
- [qutebrowser](https://qutebrowser.org/) supports showing web notifications via herbe, via the `content.notifications.presenter` setting.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue