summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2025-07-23 03:34:12 +0000
committerQMK Bot <hello@qmk.fm>2025-07-23 03:34:12 +0000
commita954b568eae25dbf1ff293cd312ef170dac0a635 (patch)
tree2b3f78682e6b5d6ec153c4b27ca00489f4e63621 /docs
parent65cce9105d4880b47052c0af57e86480784d1013 (diff)
parent74d64c7f43a9a1a0f6a0a26c981f1611ac0edaa3 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs')
-rw-r--r--docs/cli_commands.md14
-rw-r--r--docs/hardware_keyboard_guidelines.md10
-rw-r--r--docs/newbs_building_firmware.md2
-rw-r--r--docs/newbs_flashing.md2
-rw-r--r--docs/reference_info_json.md2
5 files changed, 15 insertions, 15 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index c6a7ffe191..54bf5cc123 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -17,12 +17,12 @@ qmk compile [-c] <configuratorExport.json>
17**Usage for Keymaps**: 17**Usage for Keymaps**:
18 18
19``` 19```
20qmk compile [-c] [-e <var>=<value>] [-j <num_jobs>] [--compiledb] -kb <keyboard_name> -km <keymap_name> 20qmk compile [-c] [-e <var>=<value>] [-j <num_jobs>] [--compiledb] -kb <keyboard> -km <keymap>
21``` 21```
22 22
23**Usage in Keyboard Directory**: 23**Usage in Keyboard Directory**:
24 24
25Must be in keyboard directory with a default keymap, or in keymap directory for keyboard, or supply one with `--keymap <keymap_name>` 25Must be in keyboard directory with a default keymap, or in keymap directory for keyboard, or supply one with `--keymap <keymap>`
26``` 26```
27qmk compile 27qmk compile
28``` 28```
@@ -30,7 +30,7 @@ qmk compile
30**Usage for building all keyboards that support a specific keymap**: 30**Usage for building all keyboards that support a specific keymap**:
31 31
32``` 32```
33qmk compile -kb all -km <keymap_name> 33qmk compile -kb all -km <keymap>
34``` 34```
35 35
36**Example**: 36**Example**:
@@ -62,7 +62,7 @@ $ qmk compile
62 62
63Must be under `qmk_firmware/layouts/`, and in a keymap folder. 63Must be under `qmk_firmware/layouts/`, and in a keymap folder.
64``` 64```
65qmk compile -kb <keyboard_name> 65qmk compile -kb <keyboard>
66``` 66```
67 67
68**Example**: 68**Example**:
@@ -77,11 +77,11 @@ $ qmk compile -kb dz60
77 77
78It is possible to speed up compilation by adding the `-j`/`--parallel` flag. 78It is possible to speed up compilation by adding the `-j`/`--parallel` flag.
79``` 79```
80qmk compile -j <num_jobs> -kb <keyboard_name> 80qmk compile -j <num_jobs> -kb <keyboard>
81``` 81```
82The `num_jobs` argument determines the maximum number of jobs that can be used. Setting it to zero will enable parallel compilation without limiting the maximum number of jobs. 82The `num_jobs` argument determines the maximum number of jobs that can be used. Setting it to zero will enable parallel compilation without limiting the maximum number of jobs.
83``` 83```
84qmk compile -j 0 -kb <keyboard_name> 84qmk compile -j 0 -kb <keyboard>
85``` 85```
86 86
87**Compilation Database**: 87**Compilation Database**:
@@ -120,7 +120,7 @@ qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] <configurat
120**Usage for Keymaps**: 120**Usage for Keymaps**:
121 121
122``` 122```
123qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] 123qmk flash -kb <keyboard> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>]
124``` 124```
125 125
126**Usage for pre-compiled firmwares**: 126**Usage for pre-compiled firmwares**:
diff --git a/docs/hardware_keyboard_guidelines.md b/docs/hardware_keyboard_guidelines.md
index 7e88ff231d..4df443f9fc 100644
--- a/docs/hardware_keyboard_guidelines.md
+++ b/docs/hardware_keyboard_guidelines.md
@@ -71,8 +71,8 @@ Your keyboard should be located in `qmk_firmware/keyboards/` and the folder name
71* `keyboard.json` (or `info.json`) 71* `keyboard.json` (or `info.json`)
72* `config.h` 72* `config.h`
73* `rules.mk` 73* `rules.mk`
74* `<keyboard_name>.c` 74* `<keyboard>.c`
75* `<keyboard_name>.h` 75* `<keyboard>.h`
76 76
77### `readme.md` 77### `readme.md`
78 78
@@ -203,7 +203,7 @@ The `post_rules.mk` file can interpret `features` of a keyboard-level before `co
203See `build_keyboard.mk` and `common_features.mk` for more details. 203See `build_keyboard.mk` and `common_features.mk` for more details.
204::: 204:::
205 205
206### `<keyboard_name.c>` 206### `<keyboard.c>`
207 207
208This 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. 208This 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.
209 209
@@ -214,9 +214,9 @@ The following functions are typically defined in this file:
214* `bool process_record_kb(uint16_t keycode, keyrecord_t *record)` 214* `bool process_record_kb(uint16_t keycode, keyrecord_t *record)`
215* `bool led_update_kb(led_t led_state)` 215* `bool led_update_kb(led_t led_state)`
216 216
217### `<keyboard_name.h>` 217### `<keyboard.h>`
218 218
219This 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. 219This 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.
220 220
221## Image/Hardware Files 221## Image/Hardware Files
222 222
diff --git a/docs/newbs_building_firmware.md b/docs/newbs_building_firmware.md
index f5e529b9ce..82442b7adc 100644
--- a/docs/newbs_building_firmware.md
+++ b/docs/newbs_building_firmware.md
@@ -33,7 +33,7 @@ qmk new-keymap
33If you did not configure your environment, or you have multiple keyboards, you can specify a keyboard name: 33If you did not configure your environment, or you have multiple keyboards, you can specify a keyboard name:
34 34
35```sh 35```sh
36qmk new-keymap -kb <keyboard_name> 36qmk new-keymap -kb <keyboard>
37``` 37```
38 38
39Look at the output from that command, you should see something like this: 39Look at the output from that command, you should see something like this:
diff --git a/docs/newbs_flashing.md b/docs/newbs_flashing.md
index 5d5c1983e1..8131920686 100644
--- a/docs/newbs_flashing.md
+++ b/docs/newbs_flashing.md
@@ -60,7 +60,7 @@ open .
60The firmware file always follows this naming format: 60The firmware file always follows this naming format:
61 61
62``` 62```
63<keyboard_name>_<keymap_name>.{bin,hex} 63<keyboard>_<keymap>.{bin,hex}
64``` 64```
65 65
66For example, the `planck/rev5` with a `default` keymap will have this filename: 66For example, the `planck/rev5` with a `default` keymap will have this filename:
diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md
index 71d1c5c865..c30859955f 100644
--- a/docs/reference_info_json.md
+++ b/docs/reference_info_json.md
@@ -2,7 +2,7 @@
2 2
3The information contained in `info.json` is combined with the `config.h` and `rules.mk` files, dynamically generating the necessary configuration for your keyboard at compile time. It is also used by the [QMK API](https://github.com/qmk/qmk_api), and contains the information [QMK Configurator](https://config.qmk.fm/) needs to display a representation of your keyboard. Its key/value pairs are ruled by the [`data/schemas/keyboard.jsonschema`](https://github.com/qmk/qmk_firmware/blob/master/data/schemas/keyboard.jsonschema) file. To learn more about the why and how of the schema file see the [Data Driven Configuration](data_driven_config) page. 3The information contained in `info.json` is combined with the `config.h` and `rules.mk` files, dynamically generating the necessary configuration for your keyboard at compile time. It is also used by the [QMK API](https://github.com/qmk/qmk_api), and contains the information [QMK Configurator](https://config.qmk.fm/) needs to display a representation of your keyboard. Its key/value pairs are ruled by the [`data/schemas/keyboard.jsonschema`](https://github.com/qmk/qmk_firmware/blob/master/data/schemas/keyboard.jsonschema) file. To learn more about the why and how of the schema file see the [Data Driven Configuration](data_driven_config) page.
4 4
5You can create `info.json` files at every level under `qmk_firmware/keyboards/<keyboard_name>`. These files are combined, with more specific files overriding keys in less specific files. This means you do not need to duplicate your metadata information. For example, `qmk_firmware/keyboards/clueboard/info.json` specifies information common to all Clueboard products, such as `manufacturer` and `maintainer`, while `qmk_firmware/keyboards/clueboard/66/info.json` contains more specific information about Clueboard 66%. 5You can create `info.json` files at every level under `qmk_firmware/keyboards/<keyboard>`. These files are combined, with more specific files overriding keys in less specific files. This means you do not need to duplicate your metadata information. For example, `qmk_firmware/keyboards/clueboard/info.json` specifies information common to all Clueboard products, such as `manufacturer` and `maintainer`, while `qmk_firmware/keyboards/clueboard/66/info.json` contains more specific information about Clueboard 66%.
6 6
7## General Metadata {#general-metadata} 7## General Metadata {#general-metadata}
8 8