snorenotify/README.md

63 lines
2.2 KiB
Markdown

Snorenotify
===========
Snorenotify is a multi platform Qt notification framework.
Using a plugin system it is possible to create notifications with many different notification systems on Windows, Unix and Mac.
## Supported Backends ##
- [Windows 8 toast notifications](https://github.com/Snorenotify/Snoretoast)
[ ![Windows 8 Notification](http://winkde.org/~pvonreth/other/snore/img/Thumbnail%20Pictures/win8_high.jpg) ](http://winkde.org/~pvonreth/other/snore/img/win8.png)
- OSX Notification Center
![OSX Notification Center](http://winkde.org/~pvonreth/other/snore/img/Thumbnail%20Pictures/mac2.png)
![OSX Notification Center](http://winkde.org/~pvonreth/other/snore/img/Thumbnail%20Pictures/mac.png)
- Free Desktop Notifications
[![Free Desktop Notification](http://winkde.org/~pvonreth/other/snore/img/Thumbnail%20Pictures/fd_high.jpg)](http://winkde.org/~pvonreth/other/snore/img/fd.png)
- [Growl for Windows](http://www.growlforwindows.com/)
[![Growl for Windows Notification](http://winkde.org/~pvonreth/other/snore/img/Thumbnail%20Pictures/growl_high.jpg)](http://winkde.org/~pvonreth/other/snore/img/growl.png)
- [Snarl](http://snarl.fullphat.net/)
[![Snarl Notification](http://winkde.org/~pvonreth/other/snore/img/Thumbnail%20Pictures/snarl_high.jpg)](http://winkde.org/~pvonreth/other/snore/img/snarl.png)
- Integrated notifications
[![Snore Notification](http://winkde.org/~pvonreth/other/snore/img/Thumbnail%20Pictures/snore_high.png
)](http://winkde.org/~pvonreth/other/snore/img/snore.png)
- System Tray
[![System Tray Notification](http://winkde.org/~pvonreth/other/snore/img/Thumbnail%20Pictures/tray_high.jpg)](http://winkde.org/~pvonreth/other/snore/img/tray.png)
## Projects using Snore ##
- [Quassel IRC](http://www.quassel-irc.org/)
- [Tomahawk](http://www.tomahawk-player.org/)
## API Doc ##
[A documentation of the API can be found here](http://winkde.org/~pvonreth/other/snore/doc/html/index.html)
## Dependencies ##
Required dependencies:
- [CMake](http://www.cmake.org/)
- [Qt4 or Qt5](http://qt-project.org/)
In order to build the Growl notification backend you need the following optional dependencies:
- [Crypto++](http://www.cryptopp.com/)
- [Boost](http://www.boost.org/)
- system
- thread