summaryrefslogtreecommitdiff
path: root/keyboards/winry/winry315/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/winry/winry315/readme.md')
-rw-r--r--keyboards/winry/winry315/readme.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/keyboards/winry/winry315/readme.md b/keyboards/winry/winry315/readme.md
new file mode 100644
index 0000000000..099e6b42b4
--- /dev/null
+++ b/keyboards/winry/winry315/readme.md
@@ -0,0 +1,45 @@
+# Winry315
+
+![Winry315](https://i.imgur.com/nWE5mbXh.jpeg)
+
+Winry315 is a macropad with 3 rotary encoders and 15 keys (arranged as 3 rows of 5 keys).
+
+This board may also be known as “YD3xn15mx”, “YD315” or “YD 3x15m”. Boards sold by the [SpiderIsland shop on AliExpress](https://www.aliexpress.com/store/5241107) may have “DEBROGLIE” on the bottom side of the case.
+
+More photos can be found [in this Imgur album](https://imgur.com/a/0xf9pju).
+
+* Keyboard Maintainer: [Sergey Vlasov](https://github.com/sigprof)
+* Hardware Supported: Winry315 PCB
+* Hardware Availability: [Taobao](https://world.taobao.com/item/657924681898.htm), [AliExpress](https://www.aliexpress.com/item/1005003500083583.html)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make winry/winry315:default
+
+Flashing example for this keyboard:
+
+ make winry/winry315: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 top left key (not the encoder) and plug in the keyboard. This apparently also works with the vendor VIA firmware.
+ * Note that the bootmagic key does not change with the board orientation configured using `WINRY315_DEFAULT_ORIENTATION` — the “top left” key position in the default orientation (encoders on the top side) is always used.
+* **Physical reset button**: Briefly press the button on the back of the PCB (the acrylic bottom cover should have a hole to access that button).
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available (the default keymap does not have that keycode assigned to any key, but you can use that keycode in your custom keymap if you want to have easier access to the bootloader).
+
+## Orientation
+
+Although the normal orientation of this macropad is with the encoders on the “top” side (away from the user), you may prefer using it in a sideways orientation (with the encoders on the left or right side). There are extra layout macros (`LAYOUT_left`, `LAYOUT_right` and even `LAYOUT_bottom` for completeness) which you can use in the keymap; however, just using one of those macros won't change the behavior of RGB Matrix effects. If you want to change the orientation of various RGB Matrix effects too, you can specify the desired orientation in the `config.h` file for your custom keymap by using one of the following defines:
+
+ #define WINRY315_DEFAULT_ORIENTATION WINRY315_ORIENTATION_TOP
+ #define WINRY315_DEFAULT_ORIENTATION WINRY315_ORIENTATION_LEFT
+ #define WINRY315_DEFAULT_ORIENTATION WINRY315_ORIENTATION_RIGHT
+ #define WINRY315_DEFAULT_ORIENTATION WINRY315_ORIENTATION_BOTTOM
+
+The VIA firmware changes the orientation for RGB Matrix effects automatically when the “Encoder Side” layout option is changed.
+
+Note that stems of MX switches are not symmetrical with respect to 90° rotation, so you may have some difficulties when putting the keycaps on switches if you choose one of sideways orientations.