Skip to content

Commit 135a08b

Browse files
authored
Update to latest and reword the PICODUCKY readme
The pico ducky code has evolved to be aware of layouts, so change the readme for it.
1 parent 22b5216 commit 135a08b

File tree

1 file changed

+7
-17
lines changed

1 file changed

+7
-17
lines changed

PICODUCKY.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
How to use one of these layouts with the pico-ducky repository.
1+
How to use one of these layouts with [the pico-ducky repository](https://github.com/dbisu/pico-ducky).
22

33
## First step
44

@@ -8,11 +8,11 @@ How to use one of these layouts with the pico-ducky repository.
88

99
Download the `py` zip, named `circuitpython-keyboard-layouts-py-XXXXXXXX.zip`
1010

11-
**NOTE: You can use the mpy version targetting the version of Circuitpython that is on the device, but on Raspberry Pi Pico you don't need it - they only reduce file size and memory use on load, which the pico has plenty of.**
11+
**NOTE: You can use the mpy format targetting the version of Circuitpython that is on the device (6 or 7), but on Raspberry Pi Pico you don't need it - it only reduces file size and RAM used for loading the library, which the pico has plenty of.**
1212

1313
## If your language/layout is not in the bundle
1414

15-
Try the online generator, it should get you a zip file with the bundles for yout language
15+
Try the online generator, it should be able to generate a zip file with the modules for your language.
1616

1717
https://www.neradoc.me/layouts/
1818

@@ -22,10 +22,9 @@ https://www.neradoc.me/layouts/
2222

2323
For a language `LANG`, copy the following files from the zip's `lib` folder to the `lib` directory of the board.
2424
**DO NOT** modify the adafruit_hid directory. Your files go directly in `lib`.
25-
**DO NOT** change the names or extensions of the files. Just pick the right ones.
25+
**DO NOT** change the names or extensions. Just pick the files you need.
2626
Replace `LANG` with the letters for your language of choice.
2727

28-
- `keyboard_layout.py`
2928
- `keyboard_layout_win_LANG.py`
3029
- `keycode_win_LANG.py`
3130

@@ -37,25 +36,16 @@ Don't forget to also install [the adafruit_hid library](https://github.com/adafr
3736

3837
### Modify the pico-ducky code to use your language file:
3938

40-
At the start of the file replace these lines:
39+
At the start of the file remove or comment out these lines (add `#` at the start of the line).
4140

4241
```py
43-
from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS
42+
from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS as KeyboardLayout
4443
from adafruit_hid.keycode import Keycode
4544
```
4645

47-
With this lines:
46+
And add or uncomment (remove the `#`) these lines.
4847
*Replace `LANG` with the letters for your language of choice. The name must match the file (without the py or mpy extension).*
4948
```py
5049
from keyboard_layout_win_LANG import KeyboardLayout
5150
from keycode_win_LANG import Keycode
5251
```
53-
54-
And also replace this line:
55-
```py
56-
layout = KeyboardLayoutUS(kbd)
57-
```
58-
With this line:
59-
```py
60-
layout = KeyboardLayout(kbd)
61-
```

0 commit comments

Comments
 (0)