Updated readme to point to the new kde locations

This commit is contained in:
Patrick von Reth 2015-08-24 16:31:08 +02:00
parent 44dddaa17b
commit e9c4ba3836

162
README.md
View File

@ -1,81 +1,81 @@
Snorenotify [![Build Status Travis](https://travis-ci.org/Snorenotify/Snorenotify.svg?branch=master)](https://travis-ci.org/Snorenotify/Snorenotify)
=========== [![Build status Appveyor](https://ci.appveyor.com/api/projects/status/9cjt34o5ujikxi13/branch/master?svg=true)](https://ci.appveyor.com/project/TheOneRing/snorenotify/branch/master)
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. Snorenotify
===========
For a detailed description for some of our backends see our [Wiki](https://github.com/Snorenotify/Snorenotify/wiki).
Snorenotify is a multi platform Qt notification framework.
## Support Using a plugin system it is possible to create notifications with many different notification systems on Windows, Unix and Mac.
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) .
For a detailed description for some of our backends see our [Wiki](https://techbase.kde.org/Projects/Snorenotify).
## Supported Backends ## Support
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) .
- [Windows Toast notifications](https://github.com/Snorenotify/Snorenotify/wiki/Windows-Toast-Notification)
- OSX Notification Center ## Supported Backends
- Free Desktop Notifications - [Windows Toast notifications](https://techbase.kde.org/Projects/Snorenotify/Windows-Toast-Notification)
- [Growl for Windows](http://www.growlforwindows.com/) - OSX Notification Center
- [Growl](http://growl.info/) - Free Desktop Notifications
- [Snarl](http://snarl.fullphat.net/) - [Growl for Windows](http://www.growlforwindows.com/)
- [Growl](http://growl.info/)
- [Integrated notifications](https://github.com/Snorenotify/Snorenotify/wiki/Integrated-Notification-Backend)
- [Snarl](http://snarl.fullphat.net/)
- System Tray
## Supported secondary Backends - [Integrated notifications](https://techbase.kde.org/Projects/Snorenotify/Integrated-Notification-Backend)
Secondary backends are those that allow you to send notifications to your phone, a website, play a sound. - System Tray
In difference to backends they don't offer interactions with te notification therefore any number of secondary backends might be enabled.
## Supported secondary Backends
- [Windows Phone - Toasty](http://supertoasty.com/)
- [Android - Notify my Android](https://www.notifymyandroid.com/) Secondary backends are those that allow you to send notifications to your phone, a website, play a sound.
- [Android and IOS - Pushover] (https://pushover.net/) In difference to backends they don't offer interactions with te notification therefore any number of secondary backends might be enabled.
- Playback of sound filles
- [Windows Phone - Toasty](http://supertoasty.com/)
- [Android - Notify my Android](https://www.notifymyandroid.com/)
- [Android and IOS - Pushover] (https://pushover.net/)
## Projects using Snorenotify ## - Playback of sound filles
- [Quassel IRC](http://www.quassel-irc.org/)
- [Tomahawk](http://www.tomahawk-player.org/)
## How to integrate Snorenotify in your project ## ## Projects using Snorenotify ##
### CMake ### - [Quassel IRC](http://www.quassel-irc.org/)
- [Tomahawk](http://www.tomahawk-player.org/)
project( MyApp )
cmake_minimum_required( VERSION 2.8.12 ) ## How to integrate Snorenotify in your project ##
find_package(LibsnoreQt5 0.5.91 REQUIRED) ### CMake ###
add_executable( my_app main.cpp) project( MyApp )
target_link_libraries( my_app Snore::Libsnore) cmake_minimum_required( VERSION 2.8.12 )
find_package(LibsnoreQt5 0.5.91 REQUIRED)
### Qmake ###
add_executable( my_app main.cpp)
QT += LibsnoreQt5 target_link_libraries( my_app Snore::Libsnore)
### Qmake ###
### API Doc ###
[A documentation of the API can be found here](http://patrick.von-reth.de/other/snore/latest/doc/html/index.html) QT += LibsnoreQt5
## Dependencies ## ### API Doc ###
Required dependencies: [A documentation of the API can be found here](http://api.kde.org/playground-api/libs-apidocs/snorenotify/html/index.html)
- [CMake](http://www.cmake.org/)
- [Extra CMake Modules](https://projects.kde.org/projects/kdesupport/extra-cmake-modules) ## Dependencies ##
- [Qt5](http://qt-project.org/) Required dependencies:
## Build status - [CMake](http://www.cmake.org/)
- [Windows build status on appveyor.com](https://ci.appveyor.com/project/TheOneRing/snorenotify/) - [Extra CMake Modules](https://projects.kde.org/projects/kdesupport/extra-cmake-modules)
- [Linux and Mac OSX build status on travis.org](https://travis-ci.org/Snorenotify/Snorenotify) - [Qt5](http://qt-project.org/)
## Third party libraries that we ship with our source ## ## 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 - [Snarl C++](http://sourceforge.net/p/snarlwin/code/HEAD/tree/trunk/hdr/C++/SnarlInterface_v42/) used for Snarl