diff --git a/README.md b/README.md index 495ba41..a060290 100644 --- a/README.md +++ b/README.md @@ -6,15 +6,15 @@ A dynamic tiling window manager for gnome. It is heavily inspired by DWM. Application's windows are stored in a list. This allows you to navigate via up/down key bindings (default to super J/K). Layouts dynamically arrange window in a specific pattern, the default one, the tiling arrange windows in two areas: the master and the stack. -For other layouts, refer to the [layouts section](##Layouts). +For other layouts, refer to the [layouts section](#Layouts). Fairy also implements tags, which is a superset of workspaces, if you don't care you can keep using gnome's workspaces, it will work. -If you want to see what it looks like, see the [tag section](##Tags). +If you want to see what it looks like, see the [tag section](#Tags). ## Features - - Dynamically change the layout (see [layouts](##Layouts)) for more + - Dynamically change the layout (see [layouts](#Layouts)) for more - Gaps/Smart gaps - Selected window's border - Multi-monitor support @@ -71,39 +71,39 @@ Recommended binds: - Move window to monitor left/right Conflicting binds: - - Lock screen (l) - - Hide window (h) - - Switch to application [1-9] from dock ([1-9]) + - Lock screen (`l`) + - Hide window (`h`) + - Switch to application [1-9] from dock (`[1-9]`) ### Layout bindings -| Default Keybind | Action | -| ---------------- | ------------------------------------------------------------------ | -| m | Set layout to monocle (only one window in fullscreen) | -| t | Set layout to tiling (this is the default layout) | -| d | Set layout to deck (Like tiling but only display two windows) | -| f | Set layout to floating (Effectively disable the extension) | -| l | Increase the master area by 5% | -| h | Decrease the master area by 5% | -| i | Increase the number of window in the master are | -| u | Decrease the number of window in the master are | +| Default Keybind | Action | +| ------------------ | ------------------------------------------------------------------ | +| `m` | Set layout to monocle (only one window in fullscreen) | +| `t` | Set layout to tiling (this is the default layout) | +| `d` | Set layout to deck (Like tiling but only display two windows) | +| `f` | Set layout to floating (Effectively disable the extension) | +| `l` | Increase the master area by 5% | +| `h` | Decrease the master area by 5% | +| `i` | Increase the number of window in the master are | +| `u` | Decrease the number of window in the master are | ### Window bindings -| Default Keybind | Action | -| ---------------- | ------------------------------------------------------------------ | -| k | Cycle to the next window | -| j | Cycle to the previous window | -| k | Swap the current window with next | -| j | Swap the current window with previous | -| Return | Swap the current window with the master | +| Default Keybind | Action | +| ------------------ | ------------------------------------------------------------------ | +| `k` | Cycle to the next window | +| `j` | Cycle to the previous window | +| `k` | Swap the current window with next | +| `j` | Swap the current window with previous | +| `Return` | Swap the current window with the master | ### Tags bindings -| Default Keybind | Action | -| -------------------------- | ------------------------------------------------------------------- | -| [1-9] | Switch to the selected tag/workspace for the current monitor | -| 0 | Enable all tags | -| [1-9] | Enable the select tag (add it to the currently active tags) | -| [1-9] | Move the focused window to the selected tag/worksapce | -| [1-9] | Add the focused window to the selected tag (keep all its other tags)| +| Default Keybind | Action | +| ---------------------------- | ------------------------------------------------------------------- | +| `[1-9]` | Switch to the selected tag/workspace for the current monitor | +| `0` | Enable all tags | +| `[1-9]` | Enable the select tag (add it to the currently active tags) | +| `[1-9]` | Move the focused window to the selected tag/worksapce | +| `[1-9]` | Add the focused window to the selected tag (keep all its other tags)|