Skip to content

Commit

Permalink
feat(docs): add better documentation for linux
Browse files Browse the repository at this point in the history
  • Loading branch information
eeriemyxi committed Dec 24, 2024
1 parent 18892ec commit 31e8454
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@ To understand `wskey.*` options, it is recommended to refer to documentation
available [here](usage.md#wskey).

To undersand `wskey.event_id`, you should refer to documentation available
[here](installation/linux.md#testing-access-for-input-event).
[here](installation/linux.md#getting-access-to-input-events).
6 changes: 6 additions & 0 deletions docs/installation/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ This program uses [scan codes](https://en.wikipedia.org/wiki/Scancode) to detect
keyboard input. Scan codes are not readable to normal users out-of-the-box on
Linux. Below are various methods to get access to scan codes on Linux.

You may check whether you have access to the input events via the instructions
[here](#testing-access-for-input-event).

Once you confirm you have access to the input events, read
[here](#what-to-do-next).

### Method I
This is the easier and less secure method of making scan codes readable for
processes running from your user account. First you need to add your user to the
Expand Down

0 comments on commit 31e8454

Please sign in to comment.