Skip to content

Commit 4cc7b8c

Browse files
committed
update the readme
1 parent 2a0da75 commit 4cc7b8c

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ circup install keyboard_layout_win_fr
1212

1313
`keyboard_layout_<platform>_<lang>` modules will contain the layout information for use with the `Keyboard` to type text.
1414

15+
They require also installing the `keyboard_layout.py` file, containing the base class and methods that are used by the layout. This file should be part of adafruit_hid in the future and will be removed.
16+
1517
```py
1618
import usb_hid
1719
from adafruit_hid.keyboard import Keyboard
@@ -36,4 +38,4 @@ kbd.send(Keycode.COMMAND, Keycode.A)
3638

3739
### NOTE
3840

39-
This is pretty much experimental for now, the layout and keycode files are stand-ins.
41+
A few layouts and keycodes are currently implemented, they are not thouroughly tested. The `keycode_mac_fr.py` file is more experimental.

0 commit comments

Comments
 (0)