2014-07-28 15:16:40 +02:00
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.
2015-07-10 14:00:47 +02:00
For a detailed description for some of our backends see our [Wiki ](https://github.com/Snorenotify/Snorenotify/wiki ).
2014-07-28 15:16:40 +02:00
2015-08-01 14:20:05 +02:00
## Support
2015-08-03 12:17:32 +02:00
If you need support on how to use Snorenotify you can reach out to the developers using the [mailing list ](https://mail.kde.org/mailman/listinfo/snorenotify ) or IRC joining [#Snorenotify ](irc://irc.freenode.net/snorenotify ) on freenode or using the [Web chat ](http://webchat.freenode.net/?channels=snorenotify ) .
2015-07-28 10:51:08 +02:00
2015-07-16 12:31:46 +02:00
## Supported Backends
2015-07-10 17:57:37 +02:00
- [Windows Toast notifications ](https://github.com/Snorenotify/Snorenotify/wiki/Windows-Toast-Notification )
2014-07-28 15:16:40 +02:00
- OSX Notification Center
- Free Desktop Notifications
2014-07-08 00:46:53 +02:00
- [Growl for Windows ](http://www.growlforwindows.com/ )
2015-07-10 17:34:03 +02:00
- [Growl ](http://growl.info/ )
2014-07-08 00:46:53 +02:00
- [Snarl ](http://snarl.fullphat.net/ )
2015-07-10 18:03:05 +02:00
- [Integrated notifications ](https://github.com/Snorenotify/Snorenotify/wiki/Integrated-Notification-Backend )
2014-07-08 00:46:53 +02:00
- System Tray
2015-07-16 12:31:46 +02:00
## Supported secondary Backends
Secondary backends are those that allow you to send notifications to your phone, a website, play a sound.
In difference to backends they don't offer interactions with te notification therefore any number of secondary backends might be enabled.
2015-04-18 11:47:27 +02:00
2015-07-10 17:34:23 +02:00
- [Windows Phone - Toasty ](http://supertoasty.com/ )
2015-04-18 11:47:27 +02:00
- [Android - Notify my Android ](https://www.notifymyandroid.com/ )
2015-06-25 16:25:53 +02:00
- [Android and IOS - Pushover] (https://pushover.net/)
- Playback of sound filles
2014-07-24 00:41:54 +02:00
2015-07-09 14:36:04 +02:00
## Projects using Snorenotify ##
2014-07-24 00:41:54 +02:00
- [Quassel IRC ](http://www.quassel-irc.org/ )
- [Tomahawk ](http://www.tomahawk-player.org/ )
2014-07-08 00:46:53 +02:00
2015-07-09 14:38:22 +02:00
## How to integrate Snorenotify in your project ##
### CMake ###
project( MyApp )
cmake_minimum_required( VERSION 2.8.12 )
find_package(LibsnoreQt5 0.5.91 REQUIRED)
2015-07-09 14:36:04 +02:00
2015-07-09 14:38:22 +02:00
add_executable( my_app main.cpp)
target_link_libraries( my_app Snore::Libsnore)
2015-07-09 14:36:04 +02:00
2015-07-09 14:38:22 +02:00
### Qmake ###
QT += LibsnoreQt5
2015-07-09 14:36:04 +02:00
2015-07-09 14:38:22 +02:00
### API Doc ###
2015-06-29 15:18:44 +02:00
[A documentation of the API can be found here ](http://patrick.von-reth.de/other/snore/latest/doc/html/index.html )
2014-07-24 11:59:56 +02:00
2015-07-09 14:36:04 +02:00
2014-07-24 11:59:56 +02:00
## Dependencies ##
Required dependencies:
- [CMake ](http://www.cmake.org/ )
2015-02-26 14:22:00 +01:00
- [Extra CMake Modules ](https://projects.kde.org/projects/kdesupport/extra-cmake-modules )
2015-02-26 14:22:43 +01:00
- [Qt5 ](http://qt-project.org/ )
2014-07-24 11:59:56 +02:00
2015-07-28 10:51:08 +02:00
## Build status
- [Windows build status on appveyor.com ](https://ci.appveyor.com/project/TheOneRing/snorenotify/ )
- [Linux and Mac OSX build status on travis.org ](https://travis-ci.org/Snorenotify/Snorenotify )
2014-07-24 11:59:56 +02:00
2014-07-28 15:20:12 +02:00
## Third party libraries that we ship with our source ##
- [Snarl C++ ](http://sourceforge.net/p/snarlwin/code/HEAD/tree/trunk/hdr/C++/SnarlInterface_v42/ ) used for Snarl
2014-07-28 15:16:40 +02:00
