From 3cd1eee4d3dbaf13dab4b9c0bfe78b086f311b5a Mon Sep 17 00:00:00 2001
From: Patrick von Reth <vonreth@kde.org>
Date: Tue, 25 Feb 2014 11:31:43 +0100
Subject: [PATCH] some markdown doc

---
 Doxyfile.in            |  2 +-
 README.md              | 14 +++++++++++++-
 src/core/application.h |  8 ++++----
 src/core/snore.h       | 14 +++++++-------
 4 files changed, 25 insertions(+), 13 deletions(-)

diff --git a/Doxyfile.in b/Doxyfile.in
index b6e77a0..196df69 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -1549,7 +1549,7 @@ EXTRA_SEARCH_MAPPINGS  =
 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
 # The default value is: YES.
 
-GENERATE_LATEX         = YES
+GENERATE_LATEX         = NO
 
 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
diff --git a/README.md b/README.md
index cbab67f..353fe49 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,16 @@
 Snorenotify
 ===========
 
-Snorenotify is a multiplatform Qt based notification framework. 
+Snorenotify is a multi platform Qt based 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](https://github.com/TheOneRing/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)
+
+- [Growl for Windows](http://www.growlforwindows.com/) [![Growl for Windows Notification](http://winkde.org/~pvonreth/other/snore/img/Thumbnail%20Pictures/growl_high.jpg)](http://winkde.org/~pvonreth/other/snore/img/growl.png)
+
+- [Snarl](http://snarl.fullphat.net/) [![Snarl Notification](http://winkde.org/~pvonreth/other/snore/img/Thumbnail%20Pictures/snarl_high.jpg)](http://winkde.org/~pvonreth/other/snore/img/snarl.png)
+
+- Integrated notifications [![Snore Notification](http://winkde.org/~pvonreth/other/snore/img/Thumbnail%20Pictures/snore_high.jpg)](http://winkde.org/~pvonreth/other/snore/img/snore.png)
+
+- System Tray [![System Tray Notification](http://winkde.org/~pvonreth/other/snore/img/Thumbnail%20Pictures/tray_high.jpg)](http://winkde.org/~pvonreth/other/snore/img/tray.png)
\ No newline at end of file
diff --git a/src/core/application.h b/src/core/application.h
index ce568ed..2f48925 100644
--- a/src/core/application.h
+++ b/src/core/application.h
@@ -94,10 +94,10 @@ public:
 
     /**
      * Returns application specific hints:
-     * <table>
-     * <tr><td>desktop-entry</td><td>The name of the desktop enty associated with the application</td><td>Used for The freedesktop backend</td></tr>
-     * <tr><td>windows-app-id</td><td>The app id associated with the application</td><td>Needed for the Windows 8 backend <a href="http://msdn.microsoft.com/en-us/library/windows/apps/dd378459.aspx">See MSDN</a></td></tr>
-     * </table>
+     * Key              |   Value       |   Required
+     * -------------    |   ----------- |   -----------
+     * desktop-entry    |   The name of the desktop enty associated with the application |  Used for The freedesktop backend
+     * windows-app-id   |   The app id associated with the application                   |  Needed for the Windows 8 backend [See MSDN Documentation](http://msdn.microsoft.com/en-us/library/windows/apps/dd378459.aspx)
      */
     Hint &hints();
 
diff --git a/src/core/snore.h b/src/core/snore.h
index a23e3c3..dbba552 100644
--- a/src/core/snore.h
+++ b/src/core/snore.h
@@ -37,13 +37,13 @@ class QSystemTrayIcon;
 /**
  * Snore is a platform independent Qt notification framework.
  *
- * Environment variables:
- * <table>
- * <tr><td>LIBSNORE_DEBUG_LVL</td><td>Value betwene 0 and 3 @see SnoreDebugLevels</td></tr>
- * <tr><td>LIBSNORE_LOG_TO_FILE</td><td>If 1 write to a logfile in tmp/libsnore/appname-log.txt</td></tr>
- * <tr><td>LIBSNORE_LOGFILE</td><td>Use with LIBSNORE_LOG_TO_FILE, sets the file to log to</td></tr>
- * <tr><td>LIBSNORE_FORCE_CHACHE_UPDATE</td><td>Always update the plugin cache</td></tr>
- * </table>
+ * Environment variable             | Effect
+ * ---------------------------------|-------------------------------
+ * LIBSNORE_DEBUG_LVL               |   Value betwene 0 and 3 @see SnoreDebugLevels
+ * LIBSNORE_LOG_TO_FILE             |   If 1 write to a logfile in tmp/libsnore/appname-log.txt
+ * LIBSNORE_LOGFILE                 |   Use with LIBSNORE_LOG_TO_FILE, sets the file to log to
+ * LIBSNORE_FORCE_CHACHE_UPDATE     |   Always update the plugin cache
+ *
  *
  * @author Patrick von Reth \<vonreth at kde.org\>
  */