summaryrefslogtreecommitdiffstats
path: root/data/templates/keyboard/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'data/templates/keyboard/readme.md')
-rw-r--r--data/templates/keyboard/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/data/templates/keyboard/readme.md b/data/templates/keyboard/readme.md
new file mode 100644
index 0000000000..ca703c53f0
--- /dev/null
+++ b/data/templates/keyboard/readme.md
@@ -0,0 +1,27 @@
+# %KEYBOARD%
+
+![%KEYBOARD%](imgur.com image replace me!)
+
+*A short description of the keyboard/project*
+
+* Keyboard Maintainer: [%REAL_NAME%](https://github.com/%USER_NAME%)
+* Hardware Supported: *The PCBs, controllers supported*
+* Hardware Availability: *Links to where you can find this hardware*
+
+Make example for this keyboard (after setting up your build environment):
+
+ make %KEYBOARD%:default
+
+Flashing example for this keyboard:
+
+ make %KEYBOARD%: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 `RESET` if it is available