Compare commits

...

10 Commits

Author SHA1 Message Date
Samuel Dudík dec89e4d66
Merge pull request #26 from The-Compiler/patch-2
Add projects integrating herbe to readme
2021-03-29 07:19:37 +02:00
Florian Bruhin da58d3afbd
Add projects integrating herbe to readme 2021-03-27 22:09:17 +01:00
Samuel Dudík a773e568e5
Add mention of Wayland port to README.md 2020-09-21 19:15:32 +02:00
Samuel Dudík e2091908a9
Add list of features to README.md 2020-09-20 15:22:51 +02:00
Samuel Dudík 33ae07423d
Add mention of FreeBSD patch to README.md 2020-09-18 18:39:15 +02:00
Samuel Dudík 75f2bf4b3f
Add mention of Xresources patch to Configuration 2020-09-13 07:24:35 +02:00
Samuel Dudík 829210456e
Add mention of OpenBSD patch to README.md 2020-09-09 16:52:13 +02:00
Samuel Dudík 2e6dd07f36
Update table of contents in README.md 2020-09-06 07:40:45 +02:00
Samuel Dudík c30d3081e0
Add information about packages to README.md 2020-09-05 09:45:47 +02:00
Samuel Dudík acd72dd083
Update README.md 2020-09-01 18:08:20 +02:00
1 changed files with 46 additions and 6 deletions

View File

@ -5,13 +5,38 @@
<img src="https://user-images.githubusercontent.com/24730635/90975811-cd62fd00-e537-11ea-9169-92e68a71d0a0.gif" />
</p>
## 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)
* [Actions](#actions)
* [Newlines](#newlines)
* [Multiple notifications](#multiple-notifications)
* [Notifications don't show up](#notifications-dont-show-up)
* [Installation](#installation)
* [Packages](#packages)
* [Dependencies](#dependencies)
* [Build](#build)
* [Configuration](#configuration)
* [Contribute](#contribute)
## Usage
* [Dismiss a notification](#dismiss-a-notification)
* [Actions](#actions)
* [Newlines](#newlines)
* [Multiple notifications](#multiple-notifications)
* [Notifications don't show up](#notifications-dont-show-up)
### 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
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`.
## Installation
### Packages
[![Packaging status](https://repology.org/badge/vertical-allrepos/herbe.svg)](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
* 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:
@ -95,5 +130,10 @@ You can also use `make clean` to remove the binary from the build folder, `sudo
## 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.
[Xresources patch](https://github.com/dudik/herbe/pull/11)
## 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).
## Projects with herbe integration
- [qutebrowser](https://qutebrowser.org/) supports showing web notifications via herbe, via the `content.notifications.presenter` setting.