Skip to content

Commit

Permalink
docs: remove sway and hyprland
Browse files Browse the repository at this point in the history
  • Loading branch information
VTimofeenko committed Jul 20, 2024
1 parent 4676d48 commit ba222a7
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 14 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,15 @@ Flake allows running xremap as a system-wide service and as a user service (cont

Flake implements xremap features that allow specifying per-application remapping. Following combinations are tested:

| Scenario | No features | KDE | Sway | Gnome | X11 | Hyprland |
| - | - | - | - | - | - | - |
| System | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark:`*` | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_multiplication_x:`**` |
| User | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :question: | :heavy_check_mark: |
| Scenario | No features | KDE | Gnome | X11 | Wlroots |
| - | - | - | - | - | - |
| System | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_multiplication_x: |
| User | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :question: | :heavy_check_mark: |

:heavy_check_mark: – tested, works
:heavy_multiplication_x: – not implemented
:question: – not tested

`*`: Sway system mode requires restarting the system service after user logs in for the service to pick up the Sway socket.

`**`: Hyprland feature can be enabled, but the service cannot find a socket

# How to use

TL;DR:
Expand Down
10 changes: 4 additions & 6 deletions docs/HOWTO.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ Note that flakes are required. If there is a demand for non-flake-based modules

There are two main ways of running xremap -- as a system service or as a user service. Not all combinations of mode x desktop environment are supported:

| Scenario | No features | KDE | Sway | Gnome | X11 | Hyprland |
| - | - | - | - | - | - | - |
| System | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark:`*` | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_multiplication_x:`**` |
| User | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :question: | :heavy_check_mark: |
| Scenario | No features | KDE | Gnome | X11 | Wlroots |
| - | - | - | - | - | - |
| System | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_multiplication_x: |
| User | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :question: | :heavy_check_mark: |

For all examples in this section you can copy the code into a random `flake.nix` on your machine and run it in a VM as `nix run <path_to_flake>#nixosConfigurations.nixos.config.system.build.vm`.

Expand Down Expand Up @@ -213,8 +213,6 @@ There are three categories of options:
* `withGnome`, `bool` – whether to enable Gnome support
* `withX11`, `bool` – whether to enable X11 support
* `withKDE`, `bool` – whether to enable KDE wayland support
* `withSway`, `bool` – whether to enable Sway support (consider using `withWlroots`, according to upstream)
* `withHypr`, `bool` – whether to enable Hyprland support (consider using `withWlroots`, according to upstream)

All of them are false by default, which means no application-specific remaps work as xremap does not know which application is being used.

Expand Down

0 comments on commit ba222a7

Please sign in to comment.