Add readme and license files

[pmount-gui.git] / README.txt

diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..2f6ebe6
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,17 @@
+pmount-gui is a simple graphical frontend for pmount.  It is geared towards
+minimal dependencies and only requires udev, pmount and gtk.  When run, it
+presents the user with a list of mountable devices and allows selecting the
+one to mount.  Default selection is the device which was connected to the
+system last, making it easy to quickly mount the USB memory stick you just
+plugged in.
+
+In addition, there are two command-line switches:
+
+  -u  Unmount a device.
+  -v  Increases verbosity.  Useful if pmount-gui is misbehaving.
+
+Suggested usage pattern is to bind pmount-gui to a shortcut key in your window
+manager to provide quick access.
+
+pmount-gui was written by Mikko Rasa and is distributed under the BSD license.
+See the file LICENSE.txt for full license text.