aboutsummaryrefslogtreecommitdiff
path: root/quantum/template/avr/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'quantum/template/avr/readme.md')
-rw-r--r--quantum/template/avr/readme.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/quantum/template/avr/readme.md b/quantum/template/avr/readme.md
index 0430dd0fc..fd1455842 100644
--- a/quantum/template/avr/readme.md
+++ b/quantum/template/avr/readme.md
@@ -2,14 +2,18 @@
2 2
3![%KEYBOARD%](imgur.com image replace me!) 3![%KEYBOARD%](imgur.com image replace me!)
4 4
5A short description of the keyboard/project 5*A short description of the keyboard/project*
6 6
7* Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername) 7* Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)
8* Hardware Supported: The PCBs, controllers supported 8* Hardware Supported: *The PCBs, controllers supported*
9* Hardware Availability: Links to where you can find this hardware 9* Hardware Availability: *Links to where you can find this hardware*
10 10
11Make example for this keyboard (after setting up your build environment): 11Make example for this keyboard (after setting up your build environment):
12 12
13 make %KEYBOARD%:default 13 make %KEYBOARD%:default
14 14
15Flashing example for this keyboard:
16
17 make %KEYBOARD%:default:flash
18
15See 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). 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).