kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Also made config index a bit more explicit.

Browse source
This commit is contained in:
Nicolas Munnich 2024-08-11 17:22:18 +02:00
parent d274aab26c
commit f0f2ebf647
1 changed files with 4 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/docs/config/index.md
View file

@ -37,11 +37,9 @@ ZMK will search for config files in:
...where `<board>` is the name of the board and `<module>` is the root directory of any [included module](../features/modules.mdx). These files describe the hardware of the board. ...where `<board>` is the name of the board and `<module>` is the root directory of any [included module](../features/modules.mdx). These files describe the hardware of the board.
ZMK will search the board folder for the following config files: ZMK will search the board folder for the following config files _in addition_ to [Zephyr board-defining files](https://docs.zephyrproject.org/3.5.0/hardware/porting/board_porting.html#create-your-board-directory):
- `<board>_defconfig` (Kconfig) - `<board>.conf` (Kconfig - For backwards compatibility only, do not use.)
- `<board>.conf` (Kconfig)
- `<board>.dts` (Devicetree)
- `<board>.keymap` (Devicetree, keyboards with onboard controllers only) - `<board>.keymap` (Devicetree, keyboards with onboard controllers only)
Shared config files (excluding any `_left` or `_right` suffix) are not currently supported in board folders. Shared config files (excluding any `_left` or `_right` suffix) are not currently supported in board folders.
@ -59,10 +57,9 @@ When building with a shield, ZMK will search for config files in:
...where `<shield>` is the name of the shield and `<module>` is the root directory of any [included module](../features/modules.mdx). These files describe the hardware of the shield that the board is plugged into. ...where `<shield>` is the name of the shield and `<module>` is the root directory of any [included module](../features/modules.mdx). These files describe the hardware of the shield that the board is plugged into.
ZMK will search the shield folder for the following config files: ZMK will search the shield folder for the following config files _in addition_ to [Zephyr shield-defining files](https://docs.zephyrproject.org/3.5.0/hardware/porting/shields.html#shield-porting-and-configuration):
- `<shield>.conf` (Kconfig) - `<shield>.conf` (Kconfig - For backwards compatibility only, do not use.)
- `<shield>.overlay` (Devicetree)
- `<shield>.keymap` (Devicetree) - `<shield>.keymap` (Devicetree)
Shared config files (excluding any `_left` or `_right` suffix) are not currently supported in shield folders. Shared config files (excluding any `_left` or `_right` suffix) are not currently supported in shield folders.