readme: add screenshots and improve presentation
100
README.md
@ -1,22 +1,82 @@
|
||||
[](https://github.com/dunst-project/dunst/actions?query=workflow%3Amain) [](https://codecov.io/gh/dunst-project/dunst)
|
||||
|
||||
## Dunst
|
||||
# Dunst
|
||||
|
||||
* [Wiki][wiki]
|
||||
* [Description](#description)
|
||||
<i>A highly configurable and lightweight notification daemon.</i>
|
||||
|
||||

|
||||
|
||||
## 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_
|
||||
|
||||
<a href="https://gist.github.com/NNBnh/5f6e601a6a82a6ed43b1959698758141">
|
||||
<img alt="screenshot1" src="contrib/screenshots/screenshot1_cut.png">
|
||||
</a>
|
||||
|
||||
<a href="https://gist.github.com/fwSmit/9127d988b07bcec9d869f2c927d0f616">
|
||||
<img alt="screenshot2" src="contrib/screenshots/screenshot2_cut.png">
|
||||
</a>
|
||||
|
||||
## 📜 Scripting
|
||||
|
||||
<a href="https://gitlab.manjaro.org/profiles-and-settings/manjaro-theme-settings/-/blob/master/skel/.config/dunst/dunstrc">
|
||||
<img alt="screenshot_urgency" src="contrib/screenshots/screenshot_urgency.png">
|
||||
</a>
|
||||
|
||||
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
|
||||
|
||||
<a href="https://gist.github.com/MCotocel/2b34486ae59ccda4319fcb93454d212c">
|
||||
<img alt="screenshot3" src="contrib/screenshots/screenshot3_cut.png">
|
||||
</a>
|
||||
|
||||
<a href="https://gitlab.manjaro.org/profiles-and-settings/manjaro-theme-settings/-/blob/master/skel/.config/dunst/dunstrc">
|
||||
<img alt="progress" src="https://user-images.githubusercontent.com/23078054/102542111-98b01e00-40b1-11eb-967e-bc952430bd06.png">
|
||||
</a>
|
||||
|
||||
## Maintainers
|
||||
|
||||
@ -65,13 +135,13 @@ Please use the [issue tracker][issue-tracker] provided by GitHub to send us bug
|
||||
|
||||
## Author
|
||||
|
||||
written by Sascha Kruse <dunst@knopwob.de>
|
||||
Written by Sascha Kruse <dunst@knopwob.de>
|
||||
|
||||
## 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
|
||||
|
BIN
contrib/screenshots/default_config.png
Normal file
After Width: | Height: | Size: 388 KiB |
BIN
contrib/screenshots/music.png
Normal file
After Width: | Height: | Size: 406 KiB |
BIN
contrib/screenshots/screenshot1.png
Normal file
After Width: | Height: | Size: 672 KiB |
BIN
contrib/screenshots/screenshot1_cut.png
Normal file
After Width: | Height: | Size: 214 KiB |
BIN
contrib/screenshots/screenshot2.png
Normal file
After Width: | Height: | Size: 13 KiB |
BIN
contrib/screenshots/screenshot2_cut.png
Normal file
After Width: | Height: | Size: 13 KiB |
BIN
contrib/screenshots/screenshot3.png
Normal file
After Width: | Height: | Size: 2.2 MiB |
BIN
contrib/screenshots/screenshot3_cut.png
Normal file
After Width: | Height: | Size: 90 KiB |
BIN
contrib/screenshots/screenshot_urgency.png
Normal file
After Width: | Height: | Size: 393 KiB |