diff options
Diffstat (limited to 'docs/newbs_testing_debugging.md')
| -rw-r--r-- | docs/newbs_testing_debugging.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/newbs_testing_debugging.md b/docs/newbs_testing_debugging.md index 62982584f..c6c1bd50c 100644 --- a/docs/newbs_testing_debugging.md +++ b/docs/newbs_testing_debugging.md | |||
| @@ -20,6 +20,10 @@ void keyboard_post_init_user(void) { | |||
| 20 | } | 20 | } |
| 21 | ``` | 21 | ``` |
| 22 | 22 | ||
| 23 | ## Debugging Tools | ||
| 24 | |||
| 25 | There are two different tools you can use to debug your keyboard. | ||
| 26 | |||
| 23 | ### Debugging With QMK Toolbox | 27 | ### Debugging With QMK Toolbox |
| 24 | 28 | ||
| 25 | For compatible platforms, [QMK Toolbox](https://github.com/qmk/qmk_toolbox) can be used to display debug messages from your keyboard. | 29 | For compatible platforms, [QMK Toolbox](https://github.com/qmk/qmk_toolbox) can be used to display debug messages from your keyboard. |
| @@ -28,8 +32,6 @@ For compatible platforms, [QMK Toolbox](https://github.com/qmk/qmk_toolbox) can | |||
| 28 | 32 | ||
| 29 | Prefer a terminal based solution? [hid_listen](https://www.pjrc.com/teensy/hid_listen.html), provided by PJRC, can also be used to display debug messages. Prebuilt binaries for Windows,Linux,and MacOS are available. | 33 | Prefer a terminal based solution? [hid_listen](https://www.pjrc.com/teensy/hid_listen.html), provided by PJRC, can also be used to display debug messages. Prebuilt binaries for Windows,Linux,and MacOS are available. |
| 30 | 34 | ||
| 31 | <!-- FIXME: Describe the debugging messages here. --> | ||
| 32 | |||
| 33 | ## Sending Your Own Debug Messages | 35 | ## Sending Your Own Debug Messages |
| 34 | 36 | ||
| 35 | Sometimes it's useful to print debug messages from within your [custom code](custom_quantum_functions.md). Doing so is pretty simple. Start by including `print.h` at the top of your file: | 37 | Sometimes it's useful to print debug messages from within your [custom code](custom_quantum_functions.md). Doing so is pretty simple. Start by including `print.h` at the top of your file: |
