summaryrefslogtreecommitdiff
path: root/keyboards/novelkeys/nk1/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/novelkeys/nk1/readme.md')
-rw-r--r--keyboards/novelkeys/nk1/readme.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/keyboards/novelkeys/nk1/readme.md b/keyboards/novelkeys/nk1/readme.md
new file mode 100644
index 0000000000..720d03adbc
--- /dev/null
+++ b/keyboards/novelkeys/nk1/readme.md
@@ -0,0 +1,32 @@
+# NK1
+
+A big switch keypad!
+
+* Keyboard Maintainer: [Yiancar](https://yiancar-designs.com/) and on [GitHub](https://github.com/yiancar)
+* Hardware Supported: A BIG keypad with ATmega 32u4
+* Hardware Availability: https://novelkeys.xyz/
+
+## Instructions
+
+### Build
+
+Make example for this keyboard (after setting up your build environment):
+
+ make novelkeys/nk1: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).
+
+### Reset
+
+- Unplug
+- Hold the key
+- Plug In
+- Unplug
+- Release the key
+
+### Flash
+
+- Unplug
+- Hold the key
+- Plug In
+- Flash using QMK Toolbox or dfu-util (`make nk1:<keymap>:flash`)