summaryrefslogtreecommitdiff
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 0430dd0fc9..fd14558420 100644
--- a/quantum/template/avr/readme.md
+++ b/quantum/template/avr/readme.md
@@ -2,14 +2,18 @@
![%KEYBOARD%](imgur.com image replace me!)
-A short description of the keyboard/project
+*A short description of the keyboard/project*
* Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)
-* Hardware Supported: The PCBs, controllers supported
-* Hardware Availability: Links to where you can find this hardware
+* 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).