summaryrefslogtreecommitdiff
path: root/keyboards/novelkeys/nk65/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/novelkeys/nk65/readme.md')
-rwxr-xr-xkeyboards/novelkeys/nk65/readme.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/keyboards/novelkeys/nk65/readme.md b/keyboards/novelkeys/nk65/readme.md
new file mode 100755
index 0000000000..38f66500b9
--- /dev/null
+++ b/keyboards/novelkeys/nk65/readme.md
@@ -0,0 +1,39 @@
+NK65
+=========
+
+![NK65](https://i.imgur.com/EXNbVpL.jpg)
+
+This is a standard fixed layout 65% PCB. It supports VIA and full per-key RGB.
+
+Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [GitHub](https://github.com/yiancar)
+Hardware Supported: A 65% keyboard with STM32F303CC
+Hardware Availability: https://novelkeys.xyz/
+
+Due to the RGB implementation, the NK65 is currently not compatible with community layouts.
+
+NOTE: For PCBs with revision v1.4 or later please use nk65/v1_4 in the make command.
+
+## Instructions
+
+### Build
+
+Make example for this keyboard (after setting up your build environment):
+
+ make novelkeys/nk65:via
+
+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 nk65:<keymap>:dfu-util`)