Added readme.md files for the keyboard and default layout.

This commit is contained in:
Christian C. Berclaz 2024-11-05 16:44:42 +01:00
parent 91a48c4a96
commit 550673a379
2 changed files with 32 additions and 0 deletions

View File

@ -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.

View File

@ -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