commit 1f13f47808bf0d67bc001ff1b8dbb286b8ce3db0 from: Brett Fisher date: Thu May 21 16:23:58 2026 UTC README.md: Edit for clarity and consistency. commit - f0748742c5f7f059b1167509edaab3f5e1d32b1d commit + 1f13f47808bf0d67bc001ff1b8dbb286b8ce3db0 blob - a3e71d1d076674ec3f5881c6b37b576ca61be05d blob + c02e7c0df57896ee0f47b9e8ba3d1fb4eb28d875 --- README.md +++ README.md @@ -5,17 +5,17 @@ A very basic X window manager, a.k.a Brett's X window ## Yet Another Window Manager? I went down the path of minimalist window managers a very long time -ago. I used [dwm](https://dwm.suckless.org/) for many years. I briefly -tried out both [i3](https://i3wm.org/) and [bspwm](https://github.com/baskerville/bspwm). I've relied on [cwm](https://cvsweb.openbsd.org/xenocara/app/cwm/) for the most recent several years. +ago. I used [dwm](https://dwm.suckless.org/) for many years. I tried out both + [i3](https://i3wm.org/) and [bspwm](https://github.com/baskerville/bspwm). I've relied on [cwm](https://cvsweb.openbsd.org/xenocara/app/cwm/) for the most recent several years. -One day when I should've been working, I daydreamed about a window -manager that did nothing more nor less than what I needed a window -manager to do. That matched my worflow without tweaking or patching -or scripting or hacking. +One day not too long ago when I should've been working, I daydreamed +about a window manager that did nothing more nor less than what I +needed a window manager to do. That matched my worflow without +tweaking or patching or scripting or hacking. -Dreaming led to finding minimal window manager source code, then +Dreaming led to looking up minimal window manager source code, then learning to read C code, then designing, then roadmapping, then -stumbling along writing C code, a lot of trial and error. And voila. +stumbling along writing C code, a lot of trial and error. And voilà. Here is yet another window manager. My window manager. __bxwm__. A stacking window manager that is purposely opinionated regarding @@ -36,7 +36,7 @@ philosophy, and clean, readable API design. ## Build -To build __bxwm__ from source. +Compile __bxwm__ from source. ``` make @@ -44,7 +44,8 @@ make ## Install -Install the binary and man page. Note that root privileges are not required as the default desination is `$HOME/.local/`. +Install the binary and man page. Note that root privileges are not +required as the default desination is `~/.local/`. ``` make install @@ -60,32 +61,41 @@ make uninstall ## Configuration -__bxwm__ is configured at compile-time by editing config.def.h. After making changes, the program must be recompiled and reinstalled. See bxwm(1) for details. +__bxwm__ is configured at compile-time by editing config.def.h. After +making changes, the program must be recompiled and reinstalled. See +bxwm(1) for details. ## Design & Functionality __bxwm__ is built around a set of opinionated primitives: -- Window Sizing & Placement - - New windows are opened at a golden ratio dimension, centered on the screen - - Windows can be moved and resized to - - centered half the width of the screen and full height - - right half of the screen and full height - - left half of the screen and full height - - maximized to full screen height and width, and, - - back to a small screen centered at a golden ratio dimension. + - Window Sizing & Placement + - New windows are opened + - small, centered on the screen, and, + - at a gold ratio dimension. + - Windows can be moved and resized to + - centered half the width of the screen and full height, + - right half of the screen and full height, + - left half of the screen and full height, + - maximized to full screen height and width, and, + - back to a small screen centered. -- Stacking - - Windows are maintained in a stack - - The focus follows the stack order, allowing for rapid movement between the “top” and “bottom” windows. + - Stacking + - Windows are maintained in a stack. + - Window focus follows stack order. + - Windows are navigated via key command + - next window and + - previous window. -- Workspaces - - There are 10 distinct workspaces available to organize your environment. - - Windows can be moved between workspaces, and navigation is persistent. + - Workspaces + - 10 workspaces available. + - Windows can be moved between workspaces via key commands. + - Workspaces are navigated via key command. -Window management commands via hotkeys are sent to __bxwm__ via __bxhkd__. +Window and workspace management and navigation commands via hotkeys +are sent to __bxwm__ via __bxhkd__. -To start __bxwm__, add the following line to your `~/.xinitrc`: +Add the following lines to `~/.xinitrc` to start __bxwm__. ``` exec bxwm 2> ~/.local/var/log/bxwm.log