diff --git a/README.md b/README.md index 16f6237..701ebfa 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,37 @@ # QMK Keymaps -Personal keymaps for programmable keyboards. I currently use [canary](https://github.com/Apsu/Canary) layout and am working on implementing a [magic](https://github.com/Ikcelaks/keyboard_layouts/blob/main/magic_sturdy/magic_sturdy.md) key to minimize SFB and improve flow. +Personal keymaps for programmable keyboards. ## Keyboards -- [Keychron Q4](https://www.keychron.com/products/keychron-q4-qmk-via-custom-mechanical-keyboard): -My gateway to QMK, 60% hotswappable with CNC machined body, i still use this for gaming and to retain qwerty muscle memory. +- [Keychron Q4](https://www.keychron.com/products/keychron-q4-qmk-via-custom-mechanical-keyboard) - [Corne Cherry](https://github.com/foostan/crkbd) -My intro to building keyboards, 3x6 column stagger with 3 thumb keys. This keyboard got me into alt layouts and 3D printing (case). Sports box jade clicky switches and pulse mt3 keycaps with the [splinky](https://github.com/plut0nium/0xB2) mcu for all that extra storage for our macros. -- [Gerkin](https://www.40percent.club/2016/11/gherkin.html): -Created by 40percent.club the gherkin is a 30 key keyboard with a efficient 5x6 matrix. Entry to CAD and case design, my case can be found [here](https://www.printables.com/model/824013-pcb-mount-gherkin-keyboard-case). Hand lubed milky yellow with nylon bottom housing. +- [Gerkin](https://www.40percent.club/2016/11/gherkin.html) +- [Dactyl Manuform](https://github.com/tshort/dactyl-keyboard) -## Todo -- [Dactyl Manuform](https://github.com/tshort/dactyl-keyboard): -The dactyl manuform is a parameterized, split-hand, concave, columnar, ergonomic keyboard. My personal fork used for [sajkbd](https://sajkbd.io) builds is [here](https://git.sajenim.dev/jasmine/dactyl-manuform). +## Features +* **Canary Layout** +* **Autocorrect** +* **Magic Key** +* **Home Row Mods** -## Keymaps - -## Pictures - -## Install +## Installation Follow the [getting started](https://docs.qmk.fm/#/newbs_getting_started) docs to install [QMK Firmware](https://docs.qmk.fm/#/) - # Clone the keymaps - git clone https://github.com/sajenim/qmk_keymaps.git +```sh +# Clone the keymaps +git clone https://git.sajenim.dev/jasmine/qmk_keymaps.git - # Merge our keymaps into qmk_firmware - rsync --recursive qmk_keymaps/keyboards/ qmk_firmware/keyboards/ +# Merge our keymaps into qmk_firmware +rsync --recursive qmk_keymaps/keyboards/ qmk_firmware/keyboards/ - # Compile the firmware - qmk compile -kb crkbd -km sajenim +# Compile the firmware +qmk compile -kb -km +``` + +## Pictures +![dactyl-manuform](assets/dactyl-manuform.jpg) + +## References +* [Precondition](https://precondition.github.io/home-row-mods) +* [Pascal Getreuer](https://getreuer.info/posts/keyboards/index.html) +* [ikcelaks/keyboard_layouts](https://github.com/Ikcelaks/keyboard_layouts/tree/main) diff --git a/assets/dactyl-manuform.jpg b/assets/dactyl-manuform.jpg new file mode 100644 index 0000000..cf1ee32 Binary files /dev/null and b/assets/dactyl-manuform.jpg differ