aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/sofle/readme.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2020-05-18 06:06:31 -0700
committerGitHub <noreply@github.com>2020-05-18 06:06:31 -0700
commit4adf4d5a8913d95de638bed52f41686a80145a89 (patch)
treef9ddd94311a4408673936ccbbdf8d13c3913c5db /keyboards/sofle/readme.md
parentd0e0202b272a28d6a1e7f0d059396067bb861272 (diff)
parentfb9425df827400f040c6760eff11c4b980a76a99 (diff)
downloadfirmware-4adf4d5a8913d95de638bed52f41686a80145a89.tar.gz
firmware-4adf4d5a8913d95de638bed52f41686a80145a89.tar.bz2
firmware-4adf4d5a8913d95de638bed52f41686a80145a89.zip
Add SofleKeyboard support to QMK firmware. (#8970)
* Add SofleKeyboard support to QMK firmware. * Sofle: Remove LAYOUT_kc macro for default layout. Remove unnecessary code. * Fix mistake in the latest commit * Remove duplicated layers for MAC/WIN support * Improve according to suggestion in PR * Add more improvements from PR * Fix a typo in README.md Co-authored-by: Nick Brassel <nick@tzarc.org> * Remove unneeded break. Co-authored-by: Nick Brassel <nick@tzarc.org> * Remove unneeded break. Co-authored-by: Nick Brassel <nick@tzarc.org> * Apply suggestions from code review Remove unneeded breaks. Co-authored-by: Nick Brassel <nick@tzarc.org> * Apply suggestions from code review Remove unneeded breaks (few more forgotten ones). Co-authored-by: Nick Brassel <nick@tzarc.org> * Apply suggestions from code review Co-authored-by: Drashna Jaelre <drashna@live.com> * Remove TAPPING_FORCE_HOLD from default keymap. * Add TAP_CODE_DELAY 10. Fix a typo (compilation error) Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/sofle/readme.md')
-rw-r--r--keyboards/sofle/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/sofle/readme.md b/keyboards/sofle/readme.md
new file mode 100644
index 000000000..27071e6f3
--- /dev/null
+++ b/keyboards/sofle/readme.md
@@ -0,0 +1,27 @@
+# Sofle Keyboard
+
+![SofleKeyboard version 1](https://raw.githubusercontent.com/josefadamcik/SofleKeyboard/master/Images/IMG_20200126_114622.jpg)
+
+Sofle is 6×4+5 keys column-staggered split keyboard. Based on Lily58, Corne and Helix keyboards.
+
+More details about the keyboard on my blog: [Let me introduce you SofleKeyboard - a split keyboard based on Lily58 and Crkbd](https://josef-adamcik.cz/electronics/let-me-introduce-you-sofle-keyboard-split-keyboard-based-on-lily58.html)
+
+The current (temporary) build guide and a build log is available here: [SofleKeyboard build log/guide](https://josef-adamcik.cz/electronics/soflekeyboard-build-log-and-build-guide.html)
+
+* Keyboard Maintainer: [Josef Adamcik](https://josef-adamcik.cz) [Twitter:@josefadamcik](https://twitter.com/josefadamcik)
+* Hardware Supported: SofleKeyboard PCB, ProMicro
+* Hardware Availability: [PCB & Case Data](https://github.com/josefadamcik/SofleKeyboard)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make sofle:default
+
+Flash the default keymap:
+
+ make sofle:default:avrdude
+
+Press reset button on he 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).