updated README

This commit is contained in:
Patrick Ulbrich
2011-11-29 19:15:54 +01:00
parent 5b9e2a3a8f
commit 3c8e4f76d6

View File

@@ -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")