From 3c8e4f76d6243b65056d7df5d74407cc7444330e Mon Sep 17 00:00:00 2001 From: Patrick Ulbrich Date: Tue, 29 Nov 2011 19:15:54 +0100 Subject: [PATCH] updated README --- README.md | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 56c3537..051477b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # Mailnag -A mail notification daemon for GNOME 3 +A mail notification daemon for GNOME 3. https://github.com/pulb/mailnag -Mailnag is a fork of the Popper mail notifier (http://launchpad.net/popper). -What Popper is to Ubuntu's Unity, Mailnag is to gnome-shell. +Mailnag is a fork of the Popper mail notifier (http://launchpad.net/popper). +What Popper is to Ubuntu's Unity, Mailnag is to GNOME-Shell. __This project needs contributors!__ Bugtracker: https://github.com/pulb/mailnag/issues @@ -11,11 +11,11 @@ Translations: https://translations.launchpad.net/mailnag ## Installation -### Unofficial packages +### Unofficial Packages * [Ubuntu](https://launchpad.net/~webupd8team/+archive/gnome3) * [Arch Linux](https://aur.archlinux.org/packages.php?ID=49581) -### Generic tarballs +### Generic Tarballs Distribution independent tarball releases are available [here](https://github.com/pulb/mailnag/downloads). #### Requirements @@ -28,17 +28,23 @@ Distribution independent tarball releases are available [here](https://github.co pyxdg gettext -To generate locales run `./gen_locales`. -Your language is not available? Don't hesitate - head over to https://translations.launchpad.net/mailnag +To generate locales run `./gen_locales`. +Your language is not available? Don't hesitate - head over to https://translations.launchpad.net/mailnag and translate Mailnag into your language! ## Configuration -Run `mailnag_config` to setup Mailnag. +Run `mailnag_config` to setup Mailnag. Closing the configuration window will start mailnag automatically. -Clicking a notification popup will open the default mail client specified in `System Settings -> System Info -> Default Applications`. -If you're a webmail user and want your account to be launched in a browser, please install a tool like [gnome-gmail](http://gnome-gmail.sourceforge.net). +#### Default Mail Client +Clicking a mail notification popup will open the default mail client specified in `System Settings -> System Info -> Default Applications`. +If you're a webmail (e.g. gmail) user and want your account to be launched in a browser, please install a tool like [gnome-gmail](http://gnome-gmail.sourceforge.net). + +#### Permanent Notifications +GNOME-Shell notifications are visible for a few seconds only before they vanish in GNOME's hidden messaging tray (at the bottom right corner of your screen). +If you like to have a permanently visible notification counter in your top panel, you probably want to install [this](https://github.com/pulb/shell-message-notifier) GNOME-Shell extension. + ## Screenshots ![Screenshot](http://www.shockshit.net/mailnag/screenshots/notification.png "Mail notification")