diff README @ 4:f219f96f07c2

Add README file
author Guido Berhoerster <guido+xwrited@berhoerster.name>
date Sun, 27 Apr 2014 23:12:06 +0200
parents
children 1ec432967d62
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Sun Apr 27 23:12:06 2014 +0200
@@ -0,0 +1,46 @@
+xwrited
+=======
+
+The xwrited utility displays write(1) and wall(1) messages as desktop
+notifications. A notification daemon compliant to the freedesktop.org Desktop
+Notification Specification draft needs to be running in order to display the
+notifications.
+
+Build Instructions
+------------------
+
+xwrited requires GNU make, GNU gettext, intltool, GNU or BSD install, the
+xsltproc tool from libxml2 and the following shared libraries to be installed:
+
+- GLib version 2.26 or later
+- the D-Bus GLib bindings for GLib < 2.25.5
+- libutempter on Linux and FreeBSD < 9.0
+
+It has been tested on Linux distributions, FreeBSD, NetBSD, and Solaris 11.
+
+License
+-------
+
+Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and
+distributed under the following license terms:
+
+Copyright (C) 2014 Guido Berhoerster <guido+xwrited@berhoerster.name>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.