Author: Lucas de Sena <email@example.com>
Date: Tue, 29 Aug 2023 11:49:41 -0300
|M||README|| | ||39||++++++++++++++++++++++-----------------|
1 file changed, 22 insertions(+), 17 deletions(-)
diff --git a/README b/README
@@ -14,40 +14,45 @@
-shod is a mouse-based X11 window manager that can tile and tab windows
+shod is a mouse-based X11 window manager which can tile and tab windows
inside floating containers. To tile windows, drag-and-drop the titlebar
of one window into the border of the other with the right mouse button.
-The entire grid of tiles is called a "container", and can float around
+The entire grid of tiles is called “container”, and it can float around
on the screen.
-shod works via mouse, possibly with a given modifier (Alt by default),
-and by responding to client messages sent by the shodc utility (shod's
-remote controller). With the exception of the alt-tab combination for
-cycling windows, shod does no keybinding by itself and relies on other
+shod automatically tabs related windows together on the same container.
+Dialogs and tornoff menus are only visible when their parent window is
+active, and are hidden otherwise.
+shod works via mouse (optionally with a given modifier, ALT by default)
+and by responding to client messages sent by the shodc utility (shod's
+remote controller). With the exception of the ALT-TAB combination (for
+cycling windows) shod does no keybinding by itself, and relies on other
applications (such as sxhkd) for that.
+shod displays for each container titlebars with two buttons. The right
+button closes the active window. The left button calls a command named
+shodmenu. This command is not provided with shod, it should be created
+by the user; as, for example, a xmenu script to control the window.
shod has no default bar. However shod has a dock where dockapps (small
-windows commonly used on other window managers like Window Maker) can
-be on. The dock does not appear unless a dockapp is spawned.
+windows commonly used on other window managers like WindowMaker) can be
+placed on. The dock does not appear unless a dockapp is opened.
shod can be customized by setting X resources.
-shod was inspired by the following programs and window managers. I'd
-like to thank their authors for their work that helped me developing
+shod was influenced by the following programs and window managers. I'd
+like to thank their authors for the work that helped me writing shod.
• notion: https://github.com/raboof/notion
• wmii: https://github.com/0intro/wmii
• acme: http://acme.cat-v.org/
-shod was developed after studying the code of the following window
-managers. I'd like to thank their authors for their work that helped
-me understanding how a X Window Manager works.
+shod was made after studying the code of the following window managers.
+I'd like to thank their authors for the work, that helped me understand
+how a X Window Manager works.
• dwm: https://dwm.suckless.org
• katriawm: https://www.uninformativ.de/git/katriawm/file/README.html
-See the images in the demos/ directory.
• 2.6.2 (2023-04-24): Bugfixes (wait for children processes).
• 2.6.1 (2023-04-23): Bugfixes (dockupdate).