summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Pointner <equinox@spreadspace.org>2015-09-24 16:32:58 (GMT)
committerChristian Pointner <equinox@spreadspace.org>2015-09-24 16:32:58 (GMT)
commit1e0dfe0e9a0a786fcfdedc124acdd71e968ee468 (patch)
tree89a2d9f009d5702e1656e7930e1c7d7873cdced7
parent186de605d56915b05f2d76a92b7c4c41bb4aab00 (diff)
added README
-rw-r--r--README51
1 files changed, 49 insertions, 2 deletions
diff --git a/README b/README
index 37289c0..7f20398 100644
--- a/README
+++ b/README
@@ -1,3 +1,50 @@
-DEPS:
+Introduction
+============
-libmagickwand-dev
+klokdisplay is a small command which shows images on X11 screens and
+immediatly deleting file as soon as is opened.
+klokdisplay is based on imagemagick.
+
+Dependencies
+============
+
+Linux
+-----
+
+core:
+ build-essential
+ libmagickwand-dev
+
+
+Installation
+============
+
+Getting the source via GIT:
+---------------------------
+
+git clone git://git.spreadspace.org/klokdisplay.git
+cd klokdisplay
+
+
+Building from source
+--------------------
+
+# cd src
+# ./configure
+# make
+
+
+Installing
+----------
+
+# sudo make install
+
+This will install klokdisplay under the --prefix defined with configure.
+
+
+Uninstalling
+------------
+
+# sudo make remove
+
+This removes everything except for the config files