Commit b5940c105739a785a7814e03c767ed9cce2e8cb0
Parent: cdde1a8068ab4824383021d288c0669d64429a1e
Author: mcol <mcol@posteo.net>
Date: 2021-08-22 01:29:30 +0100
Committer: mcol <mcol@posteo.net>
Committed: 2021-08-22 01:29:30 +0100

Add information to readme

README.rst Modified

@@ -1,2 +1,30 @@
 xanadu
 ======
+
+xanadu is a standalone desktop metaphor for desktop environments that do not
+bundle one, such as standalone window managers. xanadu acts as an underlay
+surface beneath regular windows that displays the contents of a specified
+directory as icons. These icons can be activated to open a given file or
+folder.
+
+Currently, the displayed folder is ``${XDG_DESKTOP_DIR:-$HOME/Desktop}``.
+
+xanadu is Gtk-based and so the style of icons and possibly other parts will be
+determined by your configured Gtk theme.
+
+
+Usage
+-----
+
+xanadu does not launch new processes itself. Instead, it simply prints the full
+path of activated items to the standard output stream. This makes it easy to
+use better-suited tools to figure out what to do.
+
+For example, this will delegate item handling to the useful ``xdg-open`` script
+packaged by many unix distributions:
+
+.. code-block:: sh
+   xanadu | while read item
+   do
+       xdg-open $item
+   done