kmk_firmware/docs/debugging.md

# Debugging
Debug will output most of the useful state to the console. This can be enable in your firmware
by setting this in your keymap. NOTE that it will be MUCH slower, so only enable this when you
need debugging.
```python
DEBUG_ENABLE = True
```

The output can be viewed by connecting to the serial port of the keybord. Please refer to [THIS](https://learn.adafruit.com/welcome-to-circuitpython/kattni-connecting-to-the-serial-console) for
more information when connecting to serial console. For Linux users, we recommend [picocom](https://github.com/npat-efault/picocom) or
[screen](https://www.gnu.org/software/screen/manual/screen.html)
Address #52 almost entirely - target upstream builds of CircuitPython and simply copy (rsync) KMK source, a basic main.py, and the user's keymap to the CIRCUITPY drive 2018-10-15 11:49:12 +02:00			`# Debugging`
Basic Docs Updated Final cleanup 2018-10-12 04:06:10 +02:00			`Debug will output most of the useful state to the console. This can be enable in your firmware`
Revert "Monocolor LED backlight added" 2019-07-08 00:35:15 +02:00			`by setting this in your keymap. NOTE that it will be MUCH slower, so only enable this when you`
Basic Docs Updated Final cleanup 2018-10-12 04:06:10 +02:00			`need debugging.`
			```python
			`DEBUG_ENABLE = True`
			```

			`The output can be viewed by connecting to the serial port of the keybord. Please refer to [THIS](https://learn.adafruit.com/welcome-to-circuitpython/kattni-connecting-to-the-serial-console) for`
			`more information when connecting to serial console. For Linux users, we recommend [picocom](https://github.com/npat-efault/picocom) or`
Address #52 almost entirely - target upstream builds of CircuitPython and simply copy (rsync) KMK source, a basic main.py, and the user's keymap to the CIRCUITPY drive 2018-10-15 11:49:12 +02:00			`[screen](https://www.gnu.org/software/screen/manual/screen.html)`