status-im
/
snorenotify
mirror of https://github.com/status-im/snorenotify.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

updated readme

This commit is contained in:
Patrick von Reth 2014-07-24 11:59:56 +02:00
parent ab3c69cd73
commit 8e4bb3bf76
1 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,12 +1,12 @@
Snorenotify Snorenotify
=========== ===========
Snorenotify is a multi platform Qt based notification framework. 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. Using a plugin system it is possible to create notifications with many different notification systems on Windows, Unix and Mac.
## Supported Backends ## ## Supported Backends ##
- [Windows 8 toast notifications](https://github.com/TheOneRing/Snoretoast) - [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) [ ![Windows 8 Notification](http://winkde.org/~pvonreth/other/snore/img/Thumbnail%20Pictures/win8_high.jpg) ](http://winkde.org/~pvonreth/other/snore/img/win8.png)
@ -45,3 +45,18 @@ Using a plugin system it is possible to create notifications with many different
## API Doc ## ## API Doc ##
[A documentation of the API can be found here](http://winkde.org/~pvonreth/other/snore/doc/html/index.html) [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