summaryrefslogtreecommitdiff
path: root/keyboards/ianklug/grooveboard/readme.md
diff options
context:
space:
mode:
authorIan Klug <ian@ianklug.com>2021-07-14 00:04:14 -0400
committerGitHub <noreply@github.com>2021-07-13 21:04:14 -0700
commit6cdba3a43724f76076b8bf1f4d0809f53e7599d9 (patch)
tree2d40a7a1f4e1178c4612e96a6325a4f3c8f11e21 /keyboards/ianklug/grooveboard/readme.md
parent2fd45959555d1cf819da89da7eaf5cf071f003a3 (diff)
[Keyboard] Add ianklug grooveboard (#13536)
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/ianklug/grooveboard/readme.md')
-rw-r--r--keyboards/ianklug/grooveboard/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/ianklug/grooveboard/readme.md b/keyboards/ianklug/grooveboard/readme.md
new file mode 100644
index 0000000000..7ea6456e38
--- /dev/null
+++ b/keyboards/ianklug/grooveboard/readme.md
@@ -0,0 +1,21 @@
+# Grooveboard
+
+A four-key mechanical keyboard for rhythm games.
+
+![Grooveboard Choc PCB](https://i.imgur.com/wbMkbHX.jpg)
+
+* Keyboard Maintainer: [ianklug](https://github.com/ianklug)
+* Hardware Supported: grooveboard, grooveboard mx, grooveboard choc
+* Hardware Availability: https://github.com/ianklug/grooveboard
+
+Press the button on the back of the keyboard to enter bootloader mode.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ianklug/grooveboard:default
+
+Flashing example for this keyboard:
+
+ make ianklug/grooveboard: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).