diff options
author | jack <[email protected]> | 2023-01-13 03:58:38 -0700 |
---|---|---|
committer | GitHub <[email protected]> | 2023-01-13 02:58:38 -0800 |
commit | b756c53c7b7fb314136571bc1dabe4947554e702 (patch) | |
tree | cf3f87c6b2b98695625c9e2d0e437f13b38adfd5 /docs/documentation_templates.md | |
parent | c965243bb70c2f3eb53bbd808bf99ea7c0ebce2d (diff) | |
download | qmk_firmware-b756c53c7b7fb314136571bc1dabe4947554e702.tar.gz qmk_firmware-b756c53c7b7fb314136571bc1dabe4947554e702.zip |
[Docs] Touch up documentation templates & porting keyboard docs (#19573)
Diffstat (limited to 'docs/documentation_templates.md')
-rw-r--r-- | docs/documentation_templates.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/documentation_templates.md b/docs/documentation_templates.md index 91ad801662..0ad4303416 100644 --- a/docs/documentation_templates.md +++ b/docs/documentation_templates.md @@ -36,5 +36,17 @@ Make example for this keyboard (after setting up your build environment): make planck/rev4:default +Flashing example for this keyboard: + + make planck/rev4:default:flash + See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). + +## Bootloader + +Enter the bootloader in 3 ways: + +* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard +* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead +* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available ``` |