2zw

2zw - X11 Windowmanager

Files | Log | Commits | Refs | README


cb7cd48

Author: erikbackman

Date: 2024-02-12

Subject: update readme

Diff

commit cb7cd48e4b3f16751e0098c8178505fc8c0d8da4
Author: erikbackman <erikbackman@users.noreply.github.com>
Date:   Mon Feb 12 00:18:30 2024 +0100

    update readme

diff --git a/README.md b/README.md
index b41c1c5..6f97d23 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,39 @@
 # EWM
 
-My Window Manager designed specifically for my workflow on an ultrawide monitor.
+A Window Manager designed specifically for my workflow on an ultrawide monitor.
+
+![Alt Text](gif.gif)
 
 ## Why
-I find that tiling window managers are terrible on ultrawide monitors
-but most floating window managers are primarly designed to be operated
-using a mouse. All I want is a floating window manager so that if I
-need to drag a window somewher I can do so without having first make
-said window float. When I only need to look at one window (which is
-most of the time) I want to be able to just center and resize to what
-I consider to be the optimal dimensions, in addition, when I need to
-view multiple windows it needs to be able to automate the task of
-tiling windows.
-
-Writing a WM that does exactly this is simpler than trying to hack on
-an existing one using some made up configuration language.
+I find that tiling window managers are terrible on ultrawide monitors,
+the main issue being that if you only have a single window on the
+screen, say a text editor, then you end up having the bulk of the text
+off to the far left. Floating window managers don't have this issue
+but most of them fall short (for me) in other aspects.
+
+Instead of writing hundereds of lines in some bespoke configuration
+language trying to add missing functionality I figured it would be
+easier to just write a window manager that just does the thing.
 
 ## Features
 - It does what I want
 - No configuration
+- Floating
+- Psuedo Tiling
 
-![Alt Text](gif.gif)
+## Keybinds
+
+| Key         | Action             |
+| ----------- | ------------------ |
+| Mod4+q 	  | quit               |
+| Mod4+f 	  | fullscreen         |
+| Mod4+m 	  | center             |
+| Mod4+comma  | previous window    |
+| Mod4+period | next window        |
+| Mod4+h 	  | tile left          |
+| Mod4+l 	  | tile right         |
+| Mod4+t 	  | tile all           |
+| Mod4+s 	  | stack (center) all |
+
+## Building
+Requires zig version 0.12.0 or later.