summaryrefslogtreecommitdiff
path: root/keyboards/bestway/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2023-12-01 10:07:56 +0000
committerQMK Bot <hello@qmk.fm>2023-12-01 10:07:56 +0000
commite0e621ad6fd6cd9db287de2584653c403fb1a2e5 (patch)
tree91476cda41fb668076dbb86e5cfa553b181b386f /keyboards/bestway/readme.md
parentcc3c3ace0c61eedd2fd8f9f668c245027ebdce1d (diff)
parent5368ddbf3d8de1059dc863f11b07831adca714c8 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/bestway/readme.md')
-rw-r--r--keyboards/bestway/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/bestway/readme.md b/keyboards/bestway/readme.md
new file mode 100644
index 0000000000..c91d09e83f
--- /dev/null
+++ b/keyboards/bestway/readme.md
@@ -0,0 +1,27 @@
+# Best - PCB
+
+![bestway](https://i.imgur.com/5q7i7ayh.jpg)
+
+A 71 keys keyboard with rgb.
+This keyboard use 16mhz HSE and STM32F103 as MCU.
+
+* Keyboard Maintainer: https://github.com/LXF-YZP
+* Hardware Supported: bestway PCB
+
+Make example for this keyboard (after setting up your build environment):
+
+ make bestway:default
+
+Flashing example for this keyboard:
+
+ make bestway: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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available \ No newline at end of file