summaryrefslogtreecommitdiff
path: root/keyboards/novelkeys/nk87b/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2022-08-30 09:50:48 +0000
committerQMK Bot <hello@qmk.fm>2022-08-30 09:50:48 +0000
commit757a03cf1a07ea61e24edf577209cb01680f44db (patch)
tree69be45a5d0e951ccbd3303f17ea08b9311baab67 /keyboards/novelkeys/nk87b/readme.md
parentef4f73ff00e7f615eba5d45940eb73b0a018093e (diff)
parenta9e726501d94906ef8ea8a48f156581e03534ba6 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/novelkeys/nk87b/readme.md')
-rw-r--r--keyboards/novelkeys/nk87b/readme.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/keyboards/novelkeys/nk87b/readme.md b/keyboards/novelkeys/nk87b/readme.md
new file mode 100644
index 0000000000..d993fb6ef4
--- /dev/null
+++ b/keyboards/novelkeys/nk87b/readme.md
@@ -0,0 +1,34 @@
+# NK87B
+
+![NK87B](https://i.imgur.com/nw29fvc.png)
+
+This is a standard fixed layout TKL PCB. It supports VIA and full per-key RGB. This is revision B.
+
+* Keyboard Maintainer: [Yiancar](https://yiancar-designs.com/) and on [GitHub](https://github.com/yiancar)
+* Hardware Supported: A TKL keyboard with STM32F072CB or APM compatible
+* Hardware Availability: https://novelkeys.xyz/
+
+## Instructions
+
+### Build
+
+Make example for this keyboard (after setting up your build environment):
+
+ make novelkeys/nk87b: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 Escape
+- Plug In
+- Unplug
+- Release Escape
+
+### Flash
+
+- Unplug
+- Hold Escape
+- Plug In
+- Flash using QMK Toolbox or dfu-util (`make nk87b:<keymap>:dfu-util`)