aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/cli_commands.md48
-rw-r--r--docs/hardware_keyboard_guidelines.md28
2 files changed, 28 insertions, 48 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index 8fa7ad41d..06568afb4 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -118,54 +118,6 @@ This command lets you configure the behavior of QMK. For the full `qmk config` d
118qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN] 118qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]
119``` 119```
120 120
121## `qmk console`
122
123This command lets you connect to keyboard consoles to get debugging messages. It only works if your keyboard firmware has been compiled with `CONSOLE_ENABLE=yes`.
124
125**Usage**:
126
127```
128qmk console [-d <pid>:<vid>[:<index>]] [-l] [-n] [-t] [-w <seconds>]
129```
130
131**Examples**:
132
133Connect to all available keyboards and show their console messages:
134
135```
136qmk console
137```
138
139List all devices:
140
141```
142qmk console -l
143```
144
145Show only messages from clueboard/66/rev3 keyboards:
146
147```
148qmk console -d C1ED:2370
149```
150
151Show only messages from the second clueboard/66/rev3:
152
153```
154qmk console -d C1ED:2370:2
155```
156
157Show timestamps and VID:PID instead of names:
158
159```
160qmk console -n -t
161```
162
163Disable bootloader messages:
164
165```
166qmk console --no-bootloaders
167```
168
169## `qmk doctor` 121## `qmk doctor`
170 122
171This command examines your environment and alerts you to potential build or flash problems. It can fix many of them if you want it to. 123This command examines your environment and alerts you to potential build or flash problems. It can fix many of them if you want it to.
diff --git a/docs/hardware_keyboard_guidelines.md b/docs/hardware_keyboard_guidelines.md
index 7630b44e0..17be7ee6a 100644
--- a/docs/hardware_keyboard_guidelines.md
+++ b/docs/hardware_keyboard_guidelines.md
@@ -144,10 +144,38 @@ The `rules.mk` file can also be placed in a sub-folder, and its reading order is
144 * `keyboards/top_folder/sub_1/sub_2/sub_3/sub_4/rules.mk` 144 * `keyboards/top_folder/sub_1/sub_2/sub_3/sub_4/rules.mk`
145 * `keyboards/top_folder/keymaps/a_keymap/rules.mk` 145 * `keyboards/top_folder/keymaps/a_keymap/rules.mk`
146 * `users/a_user_folder/rules.mk` 146 * `users/a_user_folder/rules.mk`
147 * `keyboards/top_folder/sub_1/sub_2/sub_3/sub_4/post_rules.mk`
148 * `keyboards/top_folder/sub_1/sub_2/sub_3/post_rules.mk`
149 * `keyboards/top_folder/sub_1/sub_2/post_rules.mk`
150 * `keyboards/top_folder/sub_1/post_rules.mk`
151* `keyboards/top_folder/post_rules.mk`
147* `common_features.mk` 152* `common_features.mk`
148 153
149Many of the settings written in the `rules.mk` file are interpreted by `common_features.mk`, which sets the necessary source files and compiler options. 154Many of the settings written in the `rules.mk` file are interpreted by `common_features.mk`, which sets the necessary source files and compiler options.
150 155
156The `post_rules.mk` file can interpret `features` of a keyboard-level before `common_features.mk`. For example, when your designed keyboard has the option to implement backlighting or underglow using rgblight.c, writing the following in the `post_rules.mk` makes it easier for the user to configure the `rules.mk`.
157
158* `keyboards/top_folder/keymaps/a_keymap/rules.mk`
159 ```makefile
160 # Please set the following according to the selection of the hardware implementation option.
161 RGBLED_OPTION_TYPE = backlight ## none, backlight or underglow
162 ```
163* `keyboards/top_folder/post_rules.mk`
164 ```makefile
165 ifeq ($(filter $(strip $(RGBLED_OPTION_TYPE))x, nonex backlightx underglowx x),)
166 $(error unknown RGBLED_OPTION_TYPE value "$(RGBLED_OPTION_TYPE)")
167 endif
168
169 ifeq ($(strip $(RGBLED_OPTION_TYPE)),backlight)
170 RGBLIGHT_ENABLE = yes
171 OPT_DEFS += -DRGBLED_NUM=30
172 endif
173 ifeq ($(strip $(RGBLED_OPTION_TYPE)),underglow)
174 RGBLIGHT_ENABLE = yes
175 OPT_DEFS += -DRGBLED_NUM=6
176 endif
177 ```
178
151?> See `build_keyboard.mk` and `common_features.mk` for more details. 179?> See `build_keyboard.mk` and `common_features.mk` for more details.
152 180
153### `<keyboard_name.c>` 181### `<keyboard_name.c>`