summaryrefslogtreecommitdiffstats
path: root/docs/documentation_templates.md
diff options
context:
space:
mode:
authorlokher <lokher@gmail.com>2023-04-26 16:32:15 +0800
committerlokher <lokher@gmail.com>2023-04-26 16:32:15 +0800
commite4f4ceaf3f2e3d25fb282273a81f9b58790fc427 (patch)
treec0a257eab0ffe5238fdf2c04882e8ee1fe8fc46e /docs/documentation_templates.md
parent103badc87cb50db1ff3851c84331e86ba78fb681 (diff)
merge upstream 713427c
Diffstat (limited to 'docs/documentation_templates.md')
-rw-r--r--docs/documentation_templates.md12
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
```