qmk_firmware/keyboards/windstudio/wind_x/r1/readme.md
Christian C. Berclaz 3cda9ffcd6
Adding support for Windstudio's Wind X R1 keyboard (#24564)
* Added a default firmware and layout for the WindStudio Wind X R1
keyboard.

* Wind X R1: cleaned-up the folders to make clear that this firmware is
for the release 1 of this keyboard.

* Added rules.mk to the default layout

* Renamed the folder R1 into r1.

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

* Added a license header to keymap.c

* Update keyboards/windstudio/wind_x/r1/keyboard.json

Co-authored-by: jack <jack@pngu.org>

* Update keyboards/windstudio/wind_x/r1/keyboard.json

Co-authored-by: jack <jack@pngu.org>

* Update keyboards/windstudio/wind_x/r1/keymaps/default/keymap.c

Co-authored-by: jack <jack@pngu.org>

* Update keyboards/windstudio/wind_x/r1/readme.md

Co-authored-by: jack <jack@pngu.org>

* Added a proper link to the image (logo of windstudio)

* Wind X R1
- Corrected the default keymap with the QK_GESC key instead of the
  KC_ESC.
- Removed the unnecessary rules.mk in the default layout

* Wind X R1:
applied `qmk format-json -i` on keyboard.json to conform with the
project formatt standards.

* Added a picture of the keyboard.

* Added a caption to the image.

---------

Co-authored-by: jack <jack@pngu.org>
2024-11-07 17:58:57 -07:00

29 lines
1.2 KiB
Markdown

# WindX R1 by Windstudio
![WindX R1](https://i.imgur.com/FEVczwG.jpg)
_Compact, yet feature full working or gaming keyboard_
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 w/ ATmega32U4 microcontroller
- Hardware Availability: [windstudio.store](https://windstudio.store/collections/wind-x)
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