keyboard-config/atreus/README.org

* Atreus

from keyboard.io flashed with Kaleidoscope firmware (by the lovely keyboardio folks)

** Build and run

*** Kaleidoscope

- [[https://kaleidoscope.readthedocs.io/en/latest/quick_start.html][Kaleidoscope Quick Start]]
- blog article on customizing the Atreus for (german) developers:
  (dead link)
  https://www.gettommy.com/posts/my-ergonomic-40-percent-keyboard-layout-for-german-developers/#where-to-go-from-here
- typing practise: https://www.keybr.com/
- typing speedtest with layout emulator: https://monkeytype.com/
- [[http://www.keyboard-layout-editor.com/][Keyboard Layout Editor]]

**** first time setup

- ~git clone Kaleidoscope -d ${HOME}/git/Kaleidoscope~
- ~sudo cp ${HOME}/git/Kaleidoscope/etc/60-kaleidoscope.rules /etc/udev/rules.d/~
- ~sudo udevadm trigger~
- ~cd Kaleidoscope/plugins && git clone https://github.com/keyboardio/Kaleidoscope-Languages~

**** after that just

- ~export KALEIDOSCOPE_DIR=${HOME}/git/Kaleidoscope~
- ~cd ./colemak-dhm/ && make flash~

*** QMK

#+begin_quote
Bootloader mode: while you can put the board in bootloader mode by
simply plugging it in while holding ESC down (being ESC the left
button corner key), you will need to click the RESET button to be able
to flash the board with arvdude or QMK Toolbox (there’s an hole in the
middle of the back of the board). EDIT: at least this is in my
experience, but in theory you should be able to flash the board
without using the RESET button, simply putting it in bootloader mode.
#+end_quote
https://www.reddit.com/r/olkb/comments/jaxhkk/keyboardio_atreus_how_tos_custom_layout_via_qmk/

- follow https://docs.qmk.fm/newbs_getting_started
- ./qmk/keymaps/fschl-38/ should be symlinked into =~/git/qmk_firmware/keyboards/keyboardio/atreus/keymaps/=
- =qmk compile -kb keyboardio/atreus -km fschl-38=
- https://atreus.technomancy.us/flash
https://browse.qmk.fm/#/keyboard/keyboardio/atreus
hold down bottom left key when connecting USB, then
  #+begin_src sh
    qmk flash -kb keyboardio/atreus -km fschl-38
  #+end_src
- open with chrome to do a factory reset:
  https://www.reddit.com/r/olkb/comments/jaxhkk/keyboardio_atreus_how_tos_custom_layout_via_qmk/

** The Layout

[[./keyboard-layout-colemak-DHm.png]]

[[./atreus-fschl38.svg]]

Visualize with [[https://github.com/caksoylar/keymap-drawer][Keymap-drawer]]:

#+begin_src sh
  pipx install keymap-drawer
  cd ~/git/qmk_firmware
  qmk c2json --no-cpp ~/git/qmk_firmware/keyboards/keyboardio/atreus/keymaps/fschl-38/keymap.c | keymap -c ~/git/qmk_firmware/keyboards/keyboardio/atreus/drawer-config.yaml parse -c 10 -q - >~/git/keyboard-config/atreus/atreus-fschl38.yaml
  keymap -c ~/git/qmk_firmware/keyboards/keyboardio/atreus/drawer-config.yaml draw ~/git/keyboard-config/atreus/atreus-fschl38.yaml >~/git/keyboard-config/atreus/atreus-fschl38.svg
#+end_src

*** TODO

- smart shift on a thumb key, to avoid weird situations with home-row-shift
- smart num, to avoid weird taps for the num layer when typing commas and dots
- tapdance or sth similar for ß, €
https://github.com/urob/zmk-config

*** Adjusted QWERTY Layer for gaming

[[./keyboard-layout-GW-gaming_draft.png]]