summaryrefslogtreecommitdiffstats
path: root/keyboards/churrosoft/deck8/rgb/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/churrosoft/deck8/rgb/readme.md')
-rw-r--r--keyboards/churrosoft/deck8/rgb/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/churrosoft/deck8/rgb/readme.md b/keyboards/churrosoft/deck8/rgb/readme.md
new file mode 100644
index 0000000000..87fe400c24
--- /dev/null
+++ b/keyboards/churrosoft/deck8/rgb/readme.md
@@ -0,0 +1,27 @@
+# Churrosoft Deck-8 (RGB Version)
+
+![ChurroDeck-8](https://i.imgur.com/NNmq8hzh.png)
+
+A small 8-key macropad with RGB
+
+* Keyboard Maintainer: [Polsaker](https://github.com/Polsaker)
+* Hardware Supported: ChurroDeck PCV rev. 1b, 1c and 1d
+* Hardware Availability: [churrosoft.ar](https://churrosoft.ar/deck)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make churrosoft/deck8/rgb:default
+
+Flashing example for this keyboard:
+
+ make churrosoft/deck8/rgb: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 key at (0,0) in the matrix (the top left key) and plug in the keyboard
+* **Physical reset button**: Short the `JP1` jumper in the back side of the PCB.
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available \ No newline at end of file