aboutsummaryrefslogtreecommitdiff
path: root/keyboards/yandrstudio/nz64/readme.md
diff options
context:
space:
mode:
authorJX <[email protected]>2022-05-12 12:48:47 +0800
committerGitHub <[email protected]>2022-05-11 21:48:47 -0700
commit4d1332b62c53282631aa8d24fee1105c6322352a (patch)
treed8ab44cb46cee6f8a98b2a32a8db797dd57ef7f1 /keyboards/yandrstudio/nz64/readme.md
parentffa1b37634418a4928e7d2b64cb08f31512dcedf (diff)
downloadqmk_firmware-4d1332b62c53282631aa8d24fee1105c6322352a.tar.gz
qmk_firmware-4d1332b62c53282631aa8d24fee1105c6322352a.zip
[Keyboard] Cleanup zhou65 and add nz64 keyboard (#17032)
Co-authored-by: Drashna Jaelre <[email protected]>
Diffstat (limited to 'keyboards/yandrstudio/nz64/readme.md')
-rw-r--r--keyboards/yandrstudio/nz64/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/yandrstudio/nz64/readme.md b/keyboards/yandrstudio/nz64/readme.md
new file mode 100644
index 0000000000..ca52d65ee9
--- /dev/null
+++ b/keyboards/yandrstudio/nz64/readme.md
@@ -0,0 +1,22 @@
+# nz64
+
+A 64 keys keyboard with rgb (keys).
+This keyboard use 16mhz HSE and STM32F401 as MCU.
+
+- Keyboard Maintainer: https://github.com/jiaxin96
+- Hardware Supported: nz64
+- Hardware Availability: https://github.com/Oh-My-Mechanical-Keyboard
+
+Make example for this keyboard (after setting up your build environment):
+
+ make yandrstudio/nz64:default
+
+See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key which is Escape in this keyboard) and plug in the keyboard
+* **Physical reset pins**: Short circuit the `bt0` and `vcc` pins on the back of the PCB and plug in the keyboard
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available.