summaryrefslogtreecommitdiff
path: root/keyboards/yandrstudio/zhou65/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/yandrstudio/zhou65/readme.md')
-rw-r--r--keyboards/yandrstudio/zhou65/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/yandrstudio/zhou65/readme.md b/keyboards/yandrstudio/zhou65/readme.md
new file mode 100644
index 0000000000..84c889f5ab
--- /dev/null
+++ b/keyboards/yandrstudio/zhou65/readme.md
@@ -0,0 +1,22 @@
+# zhou65 version 1.0
+
+A 65% keys keyboard with rgb (keys).
+This keyboard use 8mhz HSE and STM32F401 as MCU.
+
+- Keyboard Maintainer: https://github.com/jiaxin96
+- Hardware Supported: zhou65
+- Hardware Availability: https://github.com/Oh-My-Mechanical-Keyboard
+
+Make example for this keyboard (after setting up your build environment):
+
+ make yandrstudio/zhou65/f401: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.