]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - keyboards/novelpad/README.md
Add novelpad 0xdec keymap (#4779)
[qmk_firmware.git] / keyboards / novelpad / README.md
diff --git a/keyboards/novelpad/README.md b/keyboards/novelpad/README.md
new file mode 100644 (file)
index 0000000..70bd6b6
--- /dev/null
@@ -0,0 +1,15 @@
+# NovelPad/NumChoc
+
+![NovelPad](https://i.imgur.com/vi4EdSh.jpg?1)
+
+A 5x4 macropad/numpad, sold by NovelKeys.xyz. There are two versions of the PCB, the NovelPad for MX switches and the NumChoc for Kailh Choc low profile switches. Both utilize the same firmware with no changes required.
+
+Keyboard Maintainer: [Cole Markham](https://github.com/colemarkham) / [Woodkeys.click](https://woodkeys.click)  
+Hardware Supported: NovelPad  
+Hardware Availability: [Novelkeys.xyz](https://novelkeys.xyz)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make novelpad: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.