aboutsummaryrefslogtreecommitdiff
path: root/keyboards/ianklug/grooveboard/readme.md
diff options
context:
space:
mode:
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 000000000..7ea6456e3
--- /dev/null
+++ b/keyboards/ianklug/grooveboard/readme.md
@@ -0,0 +1,21 @@
1# Grooveboard
2
3A four-key mechanical keyboard for rhythm games.
4
5![Grooveboard Choc PCB](https://i.imgur.com/wbMkbHX.jpg)
6
7* Keyboard Maintainer: [ianklug](https://github.com/ianklug)
8* Hardware Supported: grooveboard, grooveboard mx, grooveboard choc
9* Hardware Availability: https://github.com/ianklug/grooveboard
10
11Press the button on the back of the keyboard to enter bootloader mode.
12
13Make example for this keyboard (after setting up your build environment):
14
15 make ianklug/grooveboard:default
16
17Flashing example for this keyboard:
18
19 make ianklug/grooveboard:default:flash
20
21See 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).