Skip to content

Commit e647ce5

Browse files
authored
Update README.md
1 parent 674cf38 commit e647ce5

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ It is intended to be compatible with circup for easy installation with a command
88
circup install keyboard_layout_win_fr
99
```
1010

11+
### Layouts
12+
1113
`keyboard_layout_<platform>_<lang>` modules will contain the layout information for use with the `Keyboard` to type text.
1214

1315
```py
@@ -19,6 +21,8 @@ keyboard_fr = KeyboardLayoutFR(keyboard)
1921
keyboard_fr.write("Bonjour le monde")
2022
```
2123

24+
### Keycodes
25+
2226
`keycode_<platform>_<lang>` modules are an attempt to make it easier to swap layouts. HID Keycodes normally reference the US keyboard. These these localized keycodes offer a level of conversion allowing to use `Keycode.A` across azerty and qwerty keyboards for example. It won't swap `control` and `command` to match the platform however. (yet ?)
2327

2428
```py
@@ -30,4 +34,6 @@ else:
3034
kbd.send(Keycode.COMMAND, Keycode.A)
3135
```
3236

33-
NOTE: this is pretty much experimental for now, these layouts are not for use.
37+
### NOTE
38+
39+
This is pretty much experimental for now, the layout and keycode files are stand-ins.

0 commit comments

Comments
 (0)