summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 9 insertions, 5 deletions
diff --git a/README.md b/README.md
index ad58ed8..a08fac6 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,11 @@
> ⚠️ **Note:** I won’t be updating this project for a month or so due to exams.
> Issues & PRs are welcome, just don't expect a quick response 🥀🥀
+
> **24/05/25:** I have very _little_ time but I am able to develop some features
> Thank you to the wonderful people who have sumbitted fixes and other PR's
+> **01/06/25:** I will be back to exams so I will have little to no time but I'm _finally_ nearly done with them!
+
<div align="center">
<img src="images/sxwm_logo.png" width="50%">
<br>
@@ -37,7 +40,7 @@
- **Live Config Reload**: Change your config and reload instantly with a keybind.
- **Easy Configuration**: Human-friendly `sxwmrc` file, no C required.
- **Master-Stack Layout**: DWM-inspired productive workflow.
-- **Mouse Support**: Move, swap, resize, and focus windows with the mouse.
+- **Mouse Support**: Move, swap, and resize windows with the mouse.
- **Zero Dependencies**: Only `libX11` and `Xinerama` required.
- **Lightweight**: Single C file, minimal headers, compiles in seconds.
- **Bar Friendly**: Works great with [sxbar](https://github.com/uint23/sxbar).
@@ -66,13 +69,14 @@ The file uses a `key : value` format. Lines starting with `#` are ignored.
| `border_width` | Integer | `1` | Thickness of window borders in pixels. |
| `focused_border_colour` | Hex | `#c0cbff` | Border color for the currently focused window. |
| `unfocused_border_colour`| Hex | `#555555` | Border color for unfocused windows. |
-| `swap_border_colour` | Hex | `#fff4c0` | Border color when selecting a window to swap (`MOD+Shift+Drag`). |
+| `swap_border_colour` | Hex | `#fff4c0` | Border color when selecting a window to swap (`MOD+Shift+Drag`). |
| `master_width` | Integer | `60` | Percentage of the screen width for the master window. |
| `resize_master_amount` | Integer | `1` | Percent to increase/decrease master width. |
| `snap_distance` | Integer | `5` | Distance (px) before a floating window snaps to edge. |
| `motion_throttle` | Integer | `60` | Target FPS for mouse drag actions. |
| `should_float` | String | `"st"` | Always-float rule. Multiple entries should be comma-seperated. Optionally, entries can be enclosed in quotes.|
| `new_win_focus` | Bool | `true` | Whether openening new windows should also set focus to them or keep on current window.|
+| `warp_cursor` | Bool | `true` | Warp the cursor to the middle of newly focused windows |
---
@@ -108,7 +112,7 @@ workspace : modifier + modifier + ... + key : swap n
| `focus_previous` | Moves focus backward in the stack. |
| `increase_gaps` | Expands gaps. |
| `master_next` | Moves focused window down in master/stack order. |
-| `master_previous` | Moves focused window up in master/stack order. |
+| `master_prev` | Moves focused window up in master/stack order. |
| `quit` | Exits `sxwm`. |
| `reload_config` | Reloads config. |
| `master_increase` | Expands master width. |
@@ -197,7 +201,7 @@ sudo xbps-install libX11-devel libXinerama-devel gcc make</code></pre>
<details>
<summary>Fedora / RHEL / AlmaLinux / Rocky</summary>
<pre><code>sudo dnf update
-sudo dnf install libX11-devel libXinerama-devel gcc make</code></pre>
+sudo dnf install libX11-devel libXcursor-devel libXinerama-devel gcc make</code></pre>
</details>
<details>
@@ -301,5 +305,5 @@ exec sxwm
---
<p align="center">
- <em>Contributions welcome! Open issues or submit PRs.</em>
+ <em>Contributions welcome, Please read CONTRIBUTIONS.md for more info!</em>
</p>