summaryrefslogtreecommitdiff
path: root/keyboards/yandrstudio/yr80/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/yandrstudio/yr80/readme.md')
-rw-r--r--keyboards/yandrstudio/yr80/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/yandrstudio/yr80/readme.md b/keyboards/yandrstudio/yr80/readme.md
new file mode 100644
index 0000000000..5c2ed16c1b
--- /dev/null
+++ b/keyboards/yandrstudio/yr80/readme.md
@@ -0,0 +1,22 @@
+# yr80
+
+![yr80](https://i.imgur.com/bNsbo0qh.png)
+A 80% multi-layout keyboard with 1 RGB in F13 key.
+This keyboard use 16mhz HSE and APM32F103CBT6(STM32F103CBT6) as MCU.
+
+- Keyboard Maintainer: https://github.com/jiaxin96
+- Hardware Supported: yr80
+- Hardware Availability: [TaoBao-5162](https://item.taobao.com/item.htm?id=673317975633)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make yandrstudio/yr80: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 2 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
+- **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available.