aboutsummaryrefslogtreecommitdiff
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.md40
1 files changed, 15 insertions, 25 deletions
diff --git a/keyboards/novelkeys/nk65/readme.md b/keyboards/novelkeys/nk65/readme.md
index 38f66500b9..5e30f54b31 100755
--- a/keyboards/novelkeys/nk65/readme.md
+++ b/keyboards/novelkeys/nk65/readme.md
@@ -1,39 +1,29 @@
-NK65
-=========
+# 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/
+> NOTE: For PCBs with revision v1.4 or later please use nk65/v1_4 in the make command.
-Due to the RGB implementation, the NK65 is currently not compatible with community layouts.
+This is a standard fixed layout 65% PCB. It supports VIA and full per-key RGB.
-NOTE: For PCBs with revision v1.4 or later please use nk65/v1_4 in the make command.
+* 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/
-## Instructions
+Make example for this keyboard (after setting up your build environment):
-### Build
+ make novelkeys/nk65/v1:default
-Make example for this keyboard (after setting up your build environment):
+Flashing example for this keyboard:
- make novelkeys/nk65:via
+ make novelkeys/nk65/v1:default:flash
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
+## Bootloader
-### Flash
+Enter the bootloader in 3 ways:
-- Unplug
-- Hold Escape
-- Plug In
-- Flash using QMK Toolbox or dfu-util (`make nk65:<keymap>:dfu-util`)
+* **Bootmagic reset**: Hold down the top left key and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available