aboutsummaryrefslogtreecommitdiff
path: root/keyboards/novelkeys/nk_classic_tkl_iso/readme.md
diff options
context:
space:
mode:
authoryiancar <[email protected]>2024-10-05 10:16:25 -0600
committerGitHub <[email protected]>2024-10-05 10:16:25 -0600
commite12c1fefdfedbf772d10377c85e2c3caffbdb644 (patch)
treed043081af417c4d36688f7e847c46db83e71aa02 /keyboards/novelkeys/nk_classic_tkl_iso/readme.md
parent6a73c8299b53426295e6af9c30a51a1823b872c1 (diff)
downloadqmk_firmware-e12c1fefdfedbf772d10377c85e2c3caffbdb644.tar.gz
qmk_firmware-e12c1fefdfedbf772d10377c85e2c3caffbdb644.zip
NK Classic TKL ISO (#24434)
* initial_commit * fix keymap * Update keyboards/novelkeys/nk_classic_tkl_iso/keyboard.json Co-authored-by: Duncan Sutherland <[email protected]> --------- Co-authored-by: Duncan Sutherland <[email protected]>
Diffstat (limited to 'keyboards/novelkeys/nk_classic_tkl_iso/readme.md')
-rw-r--r--keyboards/novelkeys/nk_classic_tkl_iso/readme.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/keyboards/novelkeys/nk_classic_tkl_iso/readme.md b/keyboards/novelkeys/nk_classic_tkl_iso/readme.md
new file mode 100644
index 0000000000..d748f2476a
--- /dev/null
+++ b/keyboards/novelkeys/nk_classic_tkl_iso/readme.md
@@ -0,0 +1,32 @@
+# NK Classic TKL
+
+This is a TKL ISO PCB. It supports VIA and full per-key RGB.
+
+* 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.com/
+
+## Instructions
+
+### Build
+
+Make example for this keyboard (after setting up your build environment):
+
+ make novelkeys/nk_classic_tkl_iso: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 novelkeys/nk_classic_tkl_iso:<keymap>:dfu-util`)