keychron_qmk_firmware/keyboards/keyboardio/atreus/readme.md
Evan Travers cd0e32ff9e
[Keyboard] Keyboardio Atreus (#10570)
* Initial support for the Keyboardio Atreus

Many thanks to noroadsleft for reviews & suggestions.

* Add QMK Configurator layout support

* Update the fn layer of the Keyboardio Atreus to the new layout.

Previously this was using the Classic Atreus layout.

* Implement noroadleft's changes from #8492

* Follow Erovia's recommendations

qmk/qmk_firmware#8492

* Correct braces

* Change correct rules.mk

* Remove comments

* Fix BOOTMAGIC_ENABLE

I had edited the wrong file earlier.

* Remove comment

* Updates rules.mk

Thank you noroadsleft.

Co-authored-by: Gergely Nagy <algernon@keyboard.io>
Co-authored-by: Phil Hagelberg <phil@hagelb.org>
2020-10-08 23:17:25 -07:00

1.5 KiB

Keyboardio Atreus

Atreus

A small mechanical keyboard that is based around the shape of the human hand.

These configuration files are specifically for the Keyboardio Atreus, a collaboration between Phil Hagelberg and Keyboardio. The keyboard is currently on Kickstarter, and will come fully assembled.

Make example for this keyboard (after setting up your build environment):

make keyboardio/atreus:default

Flashing example for this keyboard:

make keyboardio/atreus:default:flash

Unlike the TMK firmware, these commands should be run from the root of the repository, not the directory containing this readme.

To flash new firmware, the keyboard needs to be in bootloader mode. To do that, one needs to hold the bottom left key (Esc by default) and reset the keyboard - either via a macro, or by sending a hang-up signal to the keyboard device, or by pressing the reset button on the bottom with a pin.

See the build environment setup and the make instructions for more information. Brand new to QMK? Start with our Complete Newbs Guide.