aboutsummaryrefslogtreecommitdiff
path: root/data/templates/avr/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'data/templates/avr/readme.md')
-rw-r--r--data/templates/avr/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/data/templates/avr/readme.md b/data/templates/avr/readme.md
new file mode 100644
index 000000000..b099ed726
--- /dev/null
+++ b/data/templates/avr/readme.md
@@ -0,0 +1,27 @@
1# %KEYBOARD%
2
3![%KEYBOARD%](imgur.com image replace me!)
4
5*A short description of the keyboard/project*
6
7* Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)
8* Hardware Supported: *The PCBs, controllers supported*
9* Hardware Availability: *Links to where you can find this hardware*
10
11Make example for this keyboard (after setting up your build environment):
12
13 make %KEYBOARD%:default
14
15Flashing example for this keyboard:
16
17 make %KEYBOARD%:default:flash
18
19See 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).
20
21## Bootloader
22
23Enter the bootloader in 3 ways:
24
25* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
26* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
27* **Keycode in layout**: Press the key mapped to `RESET` if it is available