summaryrefslogtreecommitdiffstats
path: root/quantum/template/avr
diff options
context:
space:
mode:
authorMechMerlin <30334081+mechmerlin@users.noreply.github.com>2018-08-10 02:45:43 +0200
committerDrashna Jaelre <drashna@live.com>2018-08-10 02:45:43 +0200
commitccfe60eb57b6cb11c5c9914445cceae77c09c0da (patch)
tree772dd3b83192a0c45fabdb9c92b3f39a78225b53 /quantum/template/avr
parent435e9b7bdb89043b3ce8b0cfc9b0f3ee4d298166 (diff)
downloadqmk_firmware-ccfe60eb57b6cb11c5c9914445cceae77c09c0da.tar.gz
qmk_firmware-ccfe60eb57b6cb11c5c9914445cceae77c09c0da.tar.xz
Update ps2avrgb readme (#3599)
* give ps2avrgb a specific readme * add homebrew and crosspack avr step * update readme of all ps2avrgb boards to reflect the new template
Diffstat (limited to 'quantum/template/avr')
-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..d9349811d
--- /dev/null
+++ b/quantum/template/avr/readme.md
@@ -0,0 +1,15 @@
+# %KEYBOARD%
+
+![%KEYBOARD%](imgur.com image replace me!)
+
+A short description of the keyboard/project
+
+Keyboard Maintainer: [You](https://github.com/yourusername)
+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
+
+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