summaryrefslogtreecommitdiffstats
path: root/desktop/compiz-boxmenu/README
diff options
context:
space:
mode:
Diffstat (limited to 'desktop/compiz-boxmenu/README')
-rw-r--r--desktop/compiz-boxmenu/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/desktop/compiz-boxmenu/README b/desktop/compiz-boxmenu/README
new file mode 100644
index 0000000000..7e54166c6c
--- /dev/null
+++ b/desktop/compiz-boxmenu/README
@@ -0,0 +1,20 @@
+Compiz Boxmenu is a desktop menu for Compiz. It introduces extensive icon
+support, pipeitems, recent document lists, and more!
+
+Requires lxml and pyxdg.
+
+After installation, please do the following to set it up:
+
+1. Create a user-level copies of the configuration file
+
+mkdir -p ~/.config/compiz/boxmenu
+cp /etc/xdg/compiz/boxmenu/menu.xml ~/.config/compiz/boxmenu/menu.xml
+
+2. In the Compiz Settings Manager's "commands" plugin, set "Command line 0" to
+run "compiz-boxmenu". Set its hotkey to <CONTROL>space.
+
+3. In the Compiz Settings Manager's, "Viewport Switcher" plugin, navigate to
+the "Desktop-based Viewport Switching" tab. There, set "Plugin for initiate
+action" to "commands" (not "core", "commands") and "Action name for initiate"
+to "run_command0_key".
+