summaryrefslogtreecommitdiffstats
path: root/keyboards/puck/readme.md
diff options
context:
space:
mode:
authorJohn Pettigrew <john.pettigrew404@gmail.com>2018-11-27 15:43:48 -0600
committerMechMerlin <30334081+mechmerlin@users.noreply.github.com>2018-11-27 13:43:48 -0800
commitd79b5e67b691e367897a24008ec3f2188b1642f3 (patch)
treecdd14b79c3469cd83034c91f1898d43a5e49f1f1 /keyboards/puck/readme.md
parent90f9fb4eee0da25e5408e54ed872c6da2a40c5f3 (diff)
Puck Macropad (#4274)
* Add Puck * Update Manufacturer name in metadata * Add num lock to high layer * update pins * update pin settings * fix numlock key * Cleanup config.h * Update device info * updates after review
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 0000000000..45e438c471
--- /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).