diff options
Diffstat (limited to 'quantum/template/avr/readme.md')
-rw-r--r-- | quantum/template/avr/readme.md | 15 |
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..d9349811d --- /dev/null +++ b/quantum/template/avr/readme.md | |||
@@ -0,0 +1,15 @@ | |||
1 | # %KEYBOARD% | ||
2 | |||
3 |  | ||
4 | |||
5 | A short description of the keyboard/project | ||
6 | |||
7 | Keyboard Maintainer: [You](https://github.com/yourusername) | ||
8 | Hardware Supported: The PCBs, controllers supported | ||
9 | Hardware Availability: links to where you can find this hardware | ||
10 | |||
11 | Make example for this keyboard (after setting up your build environment): | ||
12 | |||
13 | make %KEYBOARD%:default | ||
14 | |||
15 | See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. \ No newline at end of file | ||