Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 34 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,40 @@ Quality couch keyboards are not so accessible, STT on Linux isn’t in a good st
## Development Setup

> [!NOTE]
> **For Linux:** On Wayland, the `ydotoold` daemon must be running and your user must be part of the `ydotool` group. Additionally, some native dependencies are required : install them via your package manager (see [`shell.nix`](shell.nix) for the list), or use `nix-shell` directly.

> **For Linux**
>
> Rein uses a virtual input device (`/dev/uinput`) for keyboard and mouse injection.
>
> On Wayland, screen capture requires a working PipeWire + XDG Desktop Portal setup (typically provided by your desktop environment).
>
> Your user must also have permission to access `/dev/uinput`. A common setup is:
>
> ```bash
> sudo tee /etc/udev/rules.d/99-rein.rules <<EOF
> KERNEL=="uinput", MODE="0660", GROUP="input"
> EOF
>
> sudo usermod -aG input $USER
>
Comment thread
coderabbitai[bot] marked this conversation as resolved.
> sudo udevadm control --reload-rules
> sudo udevadm trigger
> ```
>
> Log out and back in after running the commands above.
>
> You can verify access with:
>
> ```bash
> ls -l /dev/uinput
> ```
>
> which should show:
>
> ```text
> crw-rw---- 1 root input ... /dev/uinput
> ```
>
> Additionally, some native dependencies are required. Install them via your package manager (see [`shell.nix`](shell.nix) for the list), or use `nix-shell` directly.

### Quick Start

Expand Down
Loading
Loading