Skip to content

Commit 0980c4f

Browse files
committed
feat(docs): update install docs for linux
1 parent 81a91ae commit 0980c4f

File tree

2 files changed

+26
-5
lines changed

2 files changed

+26
-5
lines changed

docs/installation/linux.md

+25-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
1-
## Linux
1+
## Installation
2+
!!! important
3+
Minimum Python version required is 3.10. Please check by running `python3
4+
--version`.
5+
6+
Run the following command in a terminal:
7+
8+
```shell
9+
python3 -m pip install --local git+https://github.com/eeriemyxi/mechvibes-lite
10+
```
11+
12+
Now you should be able to do `mvibes --version` from your terminal. If not then
13+
I am afraid you have a messy Python3 setup on your system. However if everything
14+
is fine then please follow the next instructions in the next header.
15+
16+
## Getting Access to Input Events
217
This program uses [scan codes](https://en.wikipedia.org/wiki/Scancode) to detect
318
keyboard input. Scan codes are not readable to normal users out-of-the-box on
419
Linux. Below are various methods to get access to scan codes on Linux.
@@ -18,9 +33,10 @@ Then log out and log back in. Now you should have read access to events in
1833
instructions](#testing-access-for-input-event).
1934

2035
### Method II
21-
!!! warning
22-
This method is more involved and requires much more knowledge about what
23-
you are doing. Do not attempt it until you do.
36+
!!! warning
37+
This method is more involved and requires you to understand what you
38+
are doing; please do not attempt it if all you do right now is copy-paste
39+
random commands into your terminal.
2440

2541
When you do `mvibes daemon` it automatically starts a `wskey` daemon unless told
2642
otherwise. `wskey` daemon is essentially just a websocket server that sends the
@@ -127,3 +143,8 @@ Event: time 1734882563.557881, -------------- SYN_REPORT ------------
127143
Event: time 1734882563.726942, type 1 (EV_KEY), code 18 (KEY_E), value 1
128144
Event: time 1734882563.726942, -------------- SYN_REPORT ------------
129145
```
146+
147+
# What To Do Next?
148+
Now that you access to input events, you will have to add `wskey.event_id`
149+
option in your configuration file. More in-depth explanation is
150+
[here](../configuration.md).

uv.lock

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)