summaryrefslogtreecommitdiff
path: root/keyboards/idyllic/tinny50_rgb/readme.md
diff options
context:
space:
mode:
authorZykrah <23428162+zykrah@users.noreply.github.com>2022-12-15 07:48:45 +1100
committerGitHub <noreply@github.com>2022-12-14 12:48:45 -0800
commit35f460643aa836d5340ab7ae9585d75e26d42f8a (patch)
treef7d466f6b5ae3bbc8d1db84bd630ae8cd05a0c33 /keyboards/idyllic/tinny50_rgb/readme.md
parent53733760201f2ac42b262c119c1244fd4bc64185 (diff)
[Keyboard] Tinny50 RGB Edition (#19285)
Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/idyllic/tinny50_rgb/readme.md')
-rw-r--r--keyboards/idyllic/tinny50_rgb/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/idyllic/tinny50_rgb/readme.md b/keyboards/idyllic/tinny50_rgb/readme.md
new file mode 100644
index 0000000000..8529433a1a
--- /dev/null
+++ b/keyboards/idyllic/tinny50_rgb/readme.md
@@ -0,0 +1,27 @@
+# Tinny50 RGB Edition
+
+![Tinny50 RGB Edition](https://i.imgur.com/TMig65zh.jpg)
+
+A 50% RGB PCB designed for the Idyllic Tinny50.
+
+* Keyboard Maintainer: Zykrah
+* Hardware Supported: Tinny50 RGB Edition PCB
+* Hardware Availability: TBA
+
+Make example for this keyboard (after setting up your build environment):
+
+ make idyllic/tinny50_rgb:default
+
+Flashing example for this keyboard:
+
+ make idyllic/tinny50_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 (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press both the `BOOT` and `RESET` buttons at the same time
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available \ No newline at end of file