Skip to content

Commit abf8605

Browse files
committed
docs: update README with supported compositors and status
1 parent cd82711 commit abf8605

1 file changed

Lines changed: 16 additions & 6 deletions

File tree

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,33 +29,39 @@ And yes, it's written in Rust, so you already know it's blazing fast and memory-
2929

3030
Keystroke attempts to automatically detect your running compositor.
3131

32-
| Compositor | Support Level | Notes |
33-
|------------|---------------|-------|
34-
| **Niri** | 🟢 **Tested & Working** | Fully supported layout detection and event handling. |
35-
| **Hyprland** | 🟡 **Experimental** | Implemented but needs community testing. |
36-
| **Sway** | 🟡 **Experimental** | Implemented but needs community testing. |
37-
| **River/DWL** | 🔴 **Basic/None** | Layout detection may fail; "Basic support" is minimal. |
32+
| Compositor | Support Level | Notes |
33+
| ------------- | ----------------------- | ------------------------------------------------------ |
34+
| **Niri** | 🟢 **Tested & Working** | Fully supported layout detection and event handling. |
35+
| **Hyprland** | 🟡 **Experimental** | Implemented but needs community testing. |
36+
| **Sway** | 🟡 **Experimental** | Implemented but needs community testing. |
37+
| **River/DWL** | 🔴 **Basic/None** | Layout detection may fail; "Basic support" is minimal. |
3838

3939
> **Note**: Real compositor support is complex! I can't detect layouts reliably on all compositors without specific implementations. **I need help testing Hyprland and Sway!** If you use these, please report issues.
4040
4141
## Installation
4242

4343
### Prerequisites
44+
4445
You need a Wayland compositor and the following system libraries:
46+
4547
- `libgtk-4-dev`
4648
- `libgtk4-layer-shell-dev`
4749
- `libasound2-dev` (for audio)
4850

4951
### Via Cargo
52+
5053
If you have Rust installed:
54+
5155
```bash
5256
cargo install --path .
5357
# or
5458
cargo run --release
5559
```
5660

5761
### Via Nix
62+
5863
Flake support is included!
64+
5965
```bash
6066
# Run directly
6167
nix run github:linuxmobile/keystroke
@@ -72,17 +78,21 @@ nix develop
7278
The project is currently in **Early WIP**.
7379

7480
### 🛑 We Need Your Help!
81+
7582
1. **Compositor Testing**: We specifically need testers for **Hyprland** and **Sway**. The code is there, but I only use Niri.
7683
2. **Packaging**: We need maintainers for **AUR**, **Debian/Ubuntu**, **Fedora**, etc.
7784
3. **Feedback**: Found a bug? Open an issue!
7885

7986
### Development
87+
8088
1. Clone the repo.
8189
2. Run `cargo run` to start dev mode.
8290
3. Check `src/compositor` to understand how we handle different Wayland protocols.
8391

8492
---
93+
8594
If you find this useful, I'd really appreciate it if you could:
95+
8696
- ⭐ Drop a star on the repo!
8797
- 💡 Open an Issue with ideas.
8898
- 🛠️ Submit a PR.

0 commit comments

Comments
 (0)