Skip to content

Commit 4dccc35

Browse files
committed
update the readme with circup bundle-add and generic installation instruction
1 parent ce7ec3b commit 4dccc35

2 files changed

Lines changed: 14 additions & 4 deletions

File tree

PICODUCKY.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ https://www.neradoc.me/layouts/
1818

1919
#### Find your language/layout in the lib directory
2020

21-
For a language `LANG`, copy the following files from the zip's `lib` folder to the `lib` folder of the board. Don't change the names of the files.
21+
For a language `LANG`, copy the following files from the zip's `lib` folder to the `lib` folder of the board.
22+
*DO NOT* change the names or extensions of the files. Just pick the right ones.
2223

2324
- `keyboard_layout.py`
2425
- `keyboard_layout_win_LANG.py`
@@ -33,7 +34,7 @@ from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS
3334
from adafruit_hid.keycode import Keycode
3435
```
3536

36-
With this. Change `LANG` for you language, so the module names match the files without the extention.
37+
With this. Change `LANG` for you language, so the module names match the files without the extension.
3738
```py
3839
from keyboard_layout_win_LANG import KeyboardLayout
3940
from keycode_win_LANG import Keycode

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,21 @@
22

33
The goal of this repository is to contain a list of keyboard layouts for use with the Circuitpython [`adafruit_hid`](https://github.com/adafruit/Adafruit_CircuitPython_HID) library, that can be used as a reference for international keyboards and can be distributed as a "bundle" in the style of the Adafruit bundle.
44

5-
It is intended to be compatible with circup for easy installation with a command like this, once circup supports third-party bundles.
5+
It can be used with circup for easy installation.
66

77
```
8-
circup install keyboard_layout_win_fr
8+
circup bundle-add Neradoc/Circuitpython_Keyboard_Layouts
9+
circup install keyboard_layout_win_fr keycode_win_fr
910
```
1011

12+
## Install your language
13+
14+
To install both the layout and keycode files for your language, you need to copy 3 files to your board, in the **lib** directory of the drive. Pick the language and platforms that match yours. Use the `.py` or the `.mpy` version matching your version of Circuitpython.
15+
16+
- `keyboard_layout.mpy` (support file)
17+
- `keyboard_layout_win_fr.mpy` (pick your platform/language)
18+
- `keycode_win_fr.mpy` (pick your platform/language)
19+
1120
### Layouts
1221

1322
Layouts require first installing the `keyboard_layout` module (`keyboard_layout.mpy` in the bundle zip), containing the base class for the layouts. This file should be part of adafruit_hid in the future and will then be removed.

0 commit comments

Comments
 (0)