aboutsummaryrefslogtreecommitdiff
path: root/keyboards/windstudio/wind_x/r1/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/windstudio/wind_x/r1/readme.md')
-rw-r--r--keyboards/windstudio/wind_x/r1/readme.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/windstudio/wind_x/r1/readme.md b/keyboards/windstudio/wind_x/r1/readme.md
new file mode 100644
index 0000000000..c501951e42
--- /dev/null
+++ b/keyboards/windstudio/wind_x/r1/readme.md
@@ -0,0 +1,28 @@
+# 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