From b756c53c7b7fb314136571bc1dabe4947554e702 Mon Sep 17 00:00:00 2001 From: jack Date: Fri, 13 Jan 2023 03:58:38 -0700 Subject: [Docs] Touch up documentation templates & porting keyboard docs (#19573) --- docs/documentation_templates.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'docs/documentation_templates.md') 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 ``` -- cgit v1.2.3