drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

overhaul the newbs guide

Browse source
This commit is contained in:
skullY 2020-02-25 10:58:36 -08:00 • committed by skullydazed
parent 86f6405574
commit 45e218ceec
14 changed files with 146 additions and 153 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/newbs_testing_debugging.md
View file

@ -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: