sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Basic Docs

Browse Source 
Updated

Final cleanup
This commit is contained in:
Kyle Brown
2018-10-11 19:06:10 -07:00
parent 5313e5f5b5
commit 4c12e3a08d
7 changed files with 536 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/debugging.md Normal file
View File

@@ -0,0 +1,11 @@
#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)