aboutsummaryrefslogtreecommitdiff
path: root/quantum/template/avr/readme.md
diff options
context:
space:
mode:
authorAlex Ong <the.onga@gmail.com>2019-01-04 19:39:14 +1100
committerAlex Ong <the.onga@gmail.com>2019-01-04 19:39:14 +1100
commit47c91fc7f75ae0a477e55b687aa0fc30da0a283c (patch)
tree65ad39452748ff2e6d4a83ce54ede6ca22c9ada9 /quantum/template/avr/readme.md
parentac9b88e8ccbbf38762871504cd827ff0d941c426 (diff)
parent563ce3f225d981ce460c12ca5130dfe47af41df0 (diff)
downloadqmk_firmware-47c91fc7f75ae0a477e55b687aa0fc30da0a283c.tar.gz
qmk_firmware-47c91fc7f75ae0a477e55b687aa0fc30da0a283c.zip
Merge branch 'master' of https://github.com/qmk/qmk_firmware
Diffstat (limited to 'quantum/template/avr/readme.md')
-rw-r--r--quantum/template/avr/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/quantum/template/avr/readme.md b/quantum/template/avr/readme.md
new file mode 100644
index 000000000..d243c66a9
--- /dev/null
+++ b/quantum/template/avr/readme.md
@@ -0,0 +1,15 @@
1# %KEYBOARD%
2
3![%KEYBOARD%](imgur.com image replace me!)
4
5A short description of the keyboard/project
6
7Keyboard Maintainer: [You](https://github.com/yourusername)
8Hardware Supported: The PCBs, controllers supported
9Hardware 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
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).