From 8e4bb3bf766cd8bdb76ae9f638fa7e765602c29d Mon Sep 17 00:00:00 2001 From: Patrick von Reth Date: Thu, 24 Jul 2014 11:59:56 +0200 Subject: [PATCH] updated readme --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9b19a66..cf49e51 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ 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. ## 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) @@ -44,4 +44,19 @@ Using a plugin system it is possible to create notifications with many different - [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) \ No newline at end of file +[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 +