diff options
author | skullY <[email protected]> | 2020-02-25 10:58:36 -0800 |
---|---|---|
committer | skullydazed <[email protected]> | 2020-03-05 16:00:10 -0800 |
commit | 45e218ceec1269e5e2751146272637922cd7e9d9 (patch) | |
tree | 2dd63b29f8c5a9e3751eeb47a17ef25187525f5d /docs/newbs_testing_debugging.md | |
parent | 86f6405574d75cdc69c32829cb523aa1538ecd77 (diff) | |
download | qmk_firmware-45e218ceec1269e5e2751146272637922cd7e9d9.tar.gz qmk_firmware-45e218ceec1269e5e2751146272637922cd7e9d9.zip |
overhaul the newbs guide
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 62982584f4..c6c1bd50cb 100644 --- a/docs/newbs_testing_debugging.md +++ b/docs/newbs_testing_debugging.md @@ -20,6 +20,10 @@ void keyboard_post_init_user(void) { } ``` +## Debugging Tools + +There are two different tools you can use to debug your keyboard. + ### Debugging With QMK Toolbox 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 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. -<!-- FIXME: Describe the debugging messages here. --> - ## Sending Your Own Debug Messages 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: |