Jacob/zmk
1
0
Fork 0
forked from kofal.net/zmk
Code Pull Requests Activity

feat(docs): Add modules feature page (#2380)

Browse Source 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
This commit is contained in:
Nicolas Munnich
2024-07-25 21:08:08 +02:00
committed by GitHub
parent 97294aa341
commit f92dce43e9
6 changed files with 360 additions and 221 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/docs/config/index.md
View File

@@ -28,12 +28,14 @@ When using a split keyboard, you can use a single file without the `_left` or `_
### Board Folder
ZMK will search for config files in either of:
ZMK will search for config files in:
- [`zmk/app/boards/arm/<board>`](https://github.com/zmkfirmware/zmk/tree/main/app/boards/arm)
- `zmk-config/config/boards/arm/<board>`
- `zmk-config/boards/arm/<board>`
- `<module>/boards/arm/<board>`
- `zmk-config/config/boards/arm/<board>` (For backwards compatibility only, do not use.)
...where `<board>` is the name of the board. 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:
@@ -48,12 +50,14 @@ For more documentation on creating and configuring a new board, see [Zephyr's bo
### Shield Folder
When building with a shield, ZMK will search for config files in either of:
When building with a shield, ZMK will search for config files in:
- [`zmk/app/boards/shields/<shield>`](https://github.com/zmkfirmware/zmk/tree/main/app/boards/shields)
- `zmk-config/config/boards/shields/<shield>`
- `zmk-config/boards/shields/<shield>`
- `<module>/boards/shields/<shield>`
- `zmk-config/config/boards/shields/<shield>` (For backwards compatibility only, do not use.)
...where `<shield>` is the name of the shield. 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: