summaryrefslogtreecommitdiffstats
path: root/keyboards/rgbkb/sol3/readme.md
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2022-04-05 12:13:45 -0700
committerGitHub <noreply@github.com>2022-04-05 12:13:45 -0700
commit67bb6e19458e49008ee11fbce3a26e1967edffe4 (patch)
tree3b55ca214ec26e11aef1dfdacdf20b13c43c7679 /keyboards/rgbkb/sol3/readme.md
parent2f917dd768fda45d73ab8fd67138f7ab7d23c76c (diff)
RGBKB Sol 3 rev1: Configurator Data and Readme (#16798)
* add QMK Configurator data * add readme file
Diffstat (limited to 'keyboards/rgbkb/sol3/readme.md')
-rw-r--r--keyboards/rgbkb/sol3/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/rgbkb/sol3/readme.md b/keyboards/rgbkb/sol3/readme.md
new file mode 100644
index 0000000000..c896f7c0cd
--- /dev/null
+++ b/keyboards/rgbkb/sol3/readme.md
@@ -0,0 +1,26 @@
+# Sol 3
+
+![Sol 3](https://raw.githubusercontent.com/noroadsleft/qmk_images/master/keyboards/rgbkb/sol3/rev1/rgbkb_sol3_rev1_01.jpg)
+
+An extensible split keyboard with hotswap sockets and per-key RGB lighting.
+
+* Keyboard Maintainer: [XScorpion2](https://github.com/XScorpion2), [RGBKB](https://github.com/rgbkb)
+* Hardware Supported: RGBKB Sol 3 rev1 (STM32F303)
+* Hardware Availability: [RGBKB.net](https://www.rgbkb.net/collections/sol-3)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make rgbkb/sol3/rev1:default
+
+Flashing example for this keyboard:
+
+ make rgbkb/sol3/rev1: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
+
+To reset the board into bootloader mode, do one of the following:
+
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available (Adjust + R by default)
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard (also erases persistent settings)