summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2013-07-17 21:09:03 +0200
committerGravatar Christian Hesse <mail@eworm.de>2013-07-17 21:09:03 +0200
commit59d15c9f32056ede5213117b481124b44e750b1d (patch)
tree81dce33451e4b51b1e01be013f32a872f8216920 /README.md
parentd2b8a28fbb2c171e27db39acd21d44f2803b7951 (diff)
downloadudev-block-notify-59d15c9f32056ede5213117b481124b44e750b1d.tar.gz
udev-block-notify-59d15c9f32056ede5213117b481124b44e750b1d.tar.zst
add documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 40 insertions, 1 deletions
diff --git a/README.md b/README.md
index 5d1b2df..ad21eb7 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,43 @@
udev-block-notify
=================
-Notify about udev block events \ No newline at end of file
+**Notify about udev block events**
+
+This runs in background and produces notifications whenever udev (or systemd)
+receives an event about a block device. Notifications look like this:
+
+![Notification](screenshot.png)
+
+Requirements
+------------
+
+To compile and run `udev-block-notify` you need:
+
+* [libnotify](http://library.gnome.org/devel/notification-spec/)
+* [systemd](http://www.freedesktop.org/wiki/Software/systemd) (or `udev` which has been merge into `systemd`)
+* [markdown](http://daringfireball.net/projects/markdown/) (HTML documentation)
+
+Some systems may require additional development packages for the libraries.
+Look for `systemd-devel`, `libudev-devel` or similar.
+
+Build and install
+-----------------
+
+Building and installing is very easy. Just run:
+
+> make
+
+followed by:
+
+> make install
+
+This will place an executable at `/usr/bin/udev-block-notify`,
+documentation can be found in `/usr/share/doc/udev-block-notify/`.
+Additionally a desktop file is installed to `/etc/xdg/autostart/`, this
+automatically starts the program when logged in to a desktop environment.
+
+Usage
+-----
+
+Just run `udev-block-notify` after installation or re-login to desktop
+environment for autostart.