aboutsummaryrefslogtreecommitdiff
path: root/sysutils/py-qmk/files/pkg-message.in
blob: 80a00ec3393ec9b92c9adf62caf3e24daff02ba7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
[
{ type: install
  message: <<EOM
Setup
=====

Before finishing the setup of QMK by running `qmk setup`, it is advised to
install the python3 package first:

    # pkg install python3

The reason for this is that the qmk_firmware scripts which are downloaded
during the setup expect python3 to be installed (instead of %%PYTHON_CMD%%).

Granting Write Permissions to USB Controllers
=============================================

Flashing images to controllers as a non-root user requires
some additional setup:

1. Add the user to the "operator" group:

        # pw groupmod operator -m piotr

2. Add the following ruleset to /etc/devfs.rules:

        [qmk=10]
        add path 'ttyU*' mode 0660 group operator

3. Enable "qmk" ruleset:

        # sysrc devfs_set_rulesets+="/dev=qmk"

4. Restart the devfs service to load the new rules:

        # service devfs restart
EOM
}
]