summaryrefslogtreecommitdiff
path: root/keyboards/sofle_choc/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/sofle_choc/readme.md')
-rw-r--r--keyboards/sofle_choc/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/sofle_choc/readme.md b/keyboards/sofle_choc/readme.md
new file mode 100644
index 0000000000..5b8f47ec5a
--- /dev/null
+++ b/keyboards/sofle_choc/readme.md
@@ -0,0 +1,25 @@
+# Sofle Choc Keyboard
+
+![Sofle Choc Photo](https://i.imgur.com/MhSEAZYh.jpg)
+
+The Sofle Choc is 6×4+5 keys column-staggered split keyboard. Based on Lily58, Corne and Helix keyboards. The Sofle Choc variant uses low profile Kailh choc switches, hotswap sockets, per-key RGB using the easier to solder SK6812 Mini-E, and is fairly thin at 15mm from desktop to top of keycaps.
+
+More details about the keyboard and build guide: [Sofle Choc Build GUide](https://josefadamcik.github.io/SofleKeyboard/build_guide_choc.html)
+
+* Keyboard Maintainer: [Brian Low](https://github.com/brianlow/)
+* Hardware Supported: Sofle Choc PCB 2.x, ProMicro
+* Hardware Availability: [PCB & Case Data](https://github.com/josefadamcik/SofleKeyboard)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make sofle_choc:default
+
+Flashing example for this keyboard:
+
+ make sofle_choc:default:flash
+
+Press reset button twice on the keyboard when asked.
+
+Disconnect the first half, connect the second one and repeat the process.
+
+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).