From 550673a3792e6ac8c0253e334233633202b23ad6 Mon Sep 17 00:00:00 2001 From: "Christian C. Berclaz" Date: Tue, 5 Nov 2024 16:44:42 +0100 Subject: [PATCH] Added readme.md files for the keyboard and default layout. --- .../wind_x/r1/keymaps/default/readme.md | 6 +++++ keyboards/windstudio/wind_x/r1/readme.md | 26 +++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 keyboards/windstudio/wind_x/r1/keymaps/default/readme.md create mode 100644 keyboards/windstudio/wind_x/r1/readme.md diff --git a/keyboards/windstudio/wind_x/r1/keymaps/default/readme.md b/keyboards/windstudio/wind_x/r1/keymaps/default/readme.md new file mode 100644 index 00000000000..2fa0952a830 --- /dev/null +++ b/keyboards/windstudio/wind_x/r1/keymaps/default/readme.md @@ -0,0 +1,6 @@ +# Default Wind X R1 Layout + +This is the default layout that comes flashed on every Wind X R1. For the most +part it's a straightforward and easy to follow layout. The only unusual key is +the key in the upper left, which sends Escape normally, but Grave when any of +the Ctrl, Alt, or GUI modifiers are held down. diff --git a/keyboards/windstudio/wind_x/r1/readme.md b/keyboards/windstudio/wind_x/r1/readme.md new file mode 100644 index 00000000000..8ad488fa5d6 --- /dev/null +++ b/keyboards/windstudio/wind_x/r1/readme.md @@ -0,0 +1,26 @@ +# WindX R1 by Windstudio + +![Windstudio](https://windstudio.store) + +A large layout keyboard without the function keys. [More info on geekhack.org](https://geekhack.org/index.php?topic=114767.0) + +- Keyboard Maintainer: [Christian C. Berclaz](https://github.com/chrisgve) +- Hardware Supported: Wind X R1 + +Make example for this keyboard (after setting up your build environment): + + make windstudio/wind_x/r1:default + +Flashing example for this keyboard: + + make windstudio/wind_x/r1:default:flash + +See the [build environment setup](getting_started_build_tools) and the [make instructions](getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](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