diff --git a/README.md b/README.md index c5bd791..e3a12a5 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,82 @@ [![main](https://github.com/dunst-project/dunst/workflows/main/badge.svg)](https://github.com/dunst-project/dunst/actions?query=workflow%3Amain) [![codecov](https://codecov.io/gh/dunst-project/dunst/branch/master/graph/badge.svg)](https://codecov.io/gh/dunst-project/dunst) -## Dunst +# Dunst -* [Wiki][wiki] -* [Description](#description) +A highly configurable and lightweight notification daemon. + +![music](contrib/screenshots/music.png) + +## Table of Contents + +* [Features](#features) * [Compiling](#compiling) +* [Documentation](#documentation) * [Copyright](#copyright) -## Description +# Features -Dunst is a highly configurable and lightweight notification daemon. +## βš™οΈ Highly customizable +Customize fonts, icons, timeouts, and more. Are you unhappy with the default +shortcuts and colors? No worries, you can change these all with a simple +configuration file tweak. + +_click the images to see the dunstrc_ + + +screenshot1 + + + +screenshot2 + + +## πŸ“œ Scripting + + +screenshot_urgency + + +Run custom scripts on notifications matching a specified pattern. Have espeak +read out your notifications, or play a song when your significant other signs on +in pidgin! + +## πŸ“‹ Rules + +Change the look or behavior of notifications matching a specified pattern. You +could use this to change the color of message notifications from your favorite +jabber buddies, or to prevent important work email notifications from +disappearing until you manually dismiss them. + +## ⏸️ Pause + +If you want to take a break and not receive any notifications for a while, just +pause dunst. All notifications will be saved for you to catch up +later. + +## πŸ•˜ History + +Catch an unread notification disappearing from the corner of your eye? Just tap +a keyboard shortcut to replay the last notification, or continue tapping to see +your notification history. + +# Documentation + +Most documentation can be found in dunst's man pages. In +[**dunst(1)**](docs/dunst.1.pod) contains some general instructions on how +to run dunst and in +[**dunst(5)**](docs/dunst.5.pod) all of dunst's configuration options are +explained. + +On the dunst [wiki][wiki] you can find guides and installation instructions and +on the dunst [website][website] there is a [FAQ][FAQ] with common issues. ## Installation -### Dependencies +Dunst is available in many package repositories. If it's not available in your +distro's repositories, don't worry, it's not hard to build it yourself. -Dunst has a number of build dependencies that must be present before attempting configuration. The names are different depending on [distribution](https://github.com/dunst-project/dunst/wiki/Dependencies): +### Dependencies - dbus - libxinerama @@ -25,10 +85,12 @@ Dunst has a number of build dependencies that must be present before attempting - glib - pango/cairo - libgtk-3-dev -- libnotify (for dunstify only) +- libnotify (optional, for dunstify) - wayland-client (can build without, see [make parameters](#make-parameters)) - wayland-protocols (optional, for recompiling protocols) +The names will be different depending on your [distribution](https://github.com/dunst-project/dunst/wiki/Dependencies). + ### Building ``` @@ -52,11 +114,19 @@ sudo make install **Make sure to run all make calls with the same parameter set. So when building with `make PREFIX=/usr`, you have to install it with `make PREFIX=/usr install`, too.** -Checkout the [wiki][wiki] for more information. - ## Bug reports -Please use the [issue tracker][issue-tracker] provided by GitHub to send us bug reports or feature requests. You can also join us on the IRC channel `#dunst` on Freenode. +Please use the [issue tracker][issue-tracker] provided by GitHub to send us bug reports or feature requests. + +## Screenshots + + +screenshot3 + + + +progress + ## Maintainers @@ -65,13 +135,13 @@ Please use the [issue tracker][issue-tracker] provided by GitHub to send us bug ## Author -written by Sascha Kruse +Written by Sascha Kruse ## Copyright -copyright 2013 Sascha Kruse and contributors (see [`LICENSE`](./LICENSE) for licensing information) - -If you feel that copyrights are violated, please send me an email. +Copyright 2013 Sascha Kruse and contributors (see [`LICENSE`](./LICENSE) for licensing information) [issue-tracker]: https://github.com/dunst-project/dunst/issues [wiki]: https://github.com/dunst-project/dunst/wiki +[website]: https://dunst-project.org +[FAQ]: https://dunst-project.org/faq diff --git a/contrib/screenshots/default_config.png b/contrib/screenshots/default_config.png new file mode 100644 index 0000000..123ac0c Binary files /dev/null and b/contrib/screenshots/default_config.png differ diff --git a/contrib/screenshots/music.png b/contrib/screenshots/music.png new file mode 100644 index 0000000..e983036 Binary files /dev/null and b/contrib/screenshots/music.png differ diff --git a/contrib/screenshots/screenshot1.png b/contrib/screenshots/screenshot1.png new file mode 100644 index 0000000..4220088 Binary files /dev/null and b/contrib/screenshots/screenshot1.png differ diff --git a/contrib/screenshots/screenshot1_cut.png b/contrib/screenshots/screenshot1_cut.png new file mode 100644 index 0000000..fdfe334 Binary files /dev/null and b/contrib/screenshots/screenshot1_cut.png differ diff --git a/contrib/screenshots/screenshot2.png b/contrib/screenshots/screenshot2.png new file mode 100644 index 0000000..5d1e40a Binary files /dev/null and b/contrib/screenshots/screenshot2.png differ diff --git a/contrib/screenshots/screenshot2_cut.png b/contrib/screenshots/screenshot2_cut.png new file mode 100644 index 0000000..fb99f30 Binary files /dev/null and b/contrib/screenshots/screenshot2_cut.png differ diff --git a/contrib/screenshots/screenshot3.png b/contrib/screenshots/screenshot3.png new file mode 100644 index 0000000..9ee8ad3 Binary files /dev/null and b/contrib/screenshots/screenshot3.png differ diff --git a/contrib/screenshots/screenshot3_cut.png b/contrib/screenshots/screenshot3_cut.png new file mode 100644 index 0000000..5f0d1be Binary files /dev/null and b/contrib/screenshots/screenshot3_cut.png differ diff --git a/contrib/screenshots/screenshot_urgency.png b/contrib/screenshots/screenshot_urgency.png new file mode 100644 index 0000000..2bdc8e5 Binary files /dev/null and b/contrib/screenshots/screenshot_urgency.png differ