snorenotify/README.md

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.

For a detailed description for some of our backends see our Wiki.

Supported Backends

• Windows Toast notifications

• OSX Notification Center

• Free Desktop Notifications

• Growl for Windows

• Growl

• Snarl

• Integrated notifications

• System Tray

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.

• Windows Phone - Toasty
• Android - Notify my Android
• [Android and IOS - Pushover] (https://pushover.net/)
• Playback of sound filles

Projects using Snorenotify

• Quassel IRC
• Tomahawk

How to integrate Snorenotify in your project

CMake

project( MyApp )
cmake_minimum_required( VERSION 2.8.12 )
find_package(LibsnoreQt5 0.5.91 REQUIRED)

add_executable( my_app main.cpp)
target_link_libraries( my_app Snore::Libsnore)

Qmake

QT += LibsnoreQt5

API Doc

A documentation of the API can be found here

Dependencies

Required dependencies:

• CMake
• Extra CMake Modules
• Qt5

Third party libraries that we ship with our source

• Snarl C++ used for Snarl