me/qmk_firmware
1
0
Fork 0
forked from mirror/qmk_firmware
Code Pull Requests Activity

[docs] Align keyboard and keymap placeholders (#25509)

Browse Source
This commit is contained in:
Joel Challis
2025-07-23 04:33:37 +01:00
committed by GitHub
parent 7098252252
commit 74d64c7f43
5 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/hardware_keyboard_guidelines.md
View File

@@ -71,8 +71,8 @@ Your keyboard should be located in `qmk_firmware/keyboards/` and the folder name
* `keyboard.json` (or `info.json`)
* `config.h`
* `rules.mk`
* `<keyboard_name>.c`
* `<keyboard_name>.h`
* `<keyboard>.c`
* `<keyboard>.h`
### `readme.md`
@@ -203,7 +203,7 @@ The `post_rules.mk` file can interpret `features` of a keyboard-level before `co
See `build_keyboard.mk` and `common_features.mk` for more details.
:::
### `<keyboard_name.c>`
### `<keyboard.c>`
This file should contain C code required for the functionality of your keyboard, for example hardware initialisation code, OLED display code, and so on. This file should only contain code necessary for the keyboard to work, and *not* things that should be left to the end user to configure in their keymap. This file is automatically included in compilation if it exists. This is not a required file.
@@ -214,9 +214,9 @@ The following functions are typically defined in this file:
* `bool process_record_kb(uint16_t keycode, keyrecord_t *record)`
* `bool led_update_kb(led_t led_state)`
### `<keyboard_name.h>`
### `<keyboard.h>`
This file can contain function prototypes for custom functions and other header file code utilised by `<keyboard_name>.c`. The `<keyboard_name>.c` file should include this file. This is not a required file.
This file can contain function prototypes for custom functions and other header file code utilised by `<keyboard>.c`. The `<keyboard>.c` file should include this file. This is not a required file.
## Image/Hardware Files