summaryrefslogtreecommitdiffstats
path: root/keyboards/puck/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/puck/readme.md')
-rw-r--r--keyboards/puck/readme.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/keyboards/puck/readme.md b/keyboards/puck/readme.md
new file mode 100644
index 000000000..45e438c47
--- /dev/null
+++ b/keyboards/puck/readme.md
@@ -0,0 +1,11 @@
+A 4 x 3 macropad.
+
+Keyboard Maintainer: [john-pettigrew](https://github.com/john-pettigrew)
+Hardware Supported: Puck PCB.
+Hardware Availability: [OkKeebs.com](https://okkeebs.com/products/puck-pcb)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make puck:default
+
+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).