summaryrefslogtreecommitdiff
path: root/keyboards/keyboardio/atreus/readme.md
diff options
context:
space:
mode:
authorEvan Travers <evantravers@gmail.com>2020-10-09 01:17:25 -0500
committerGitHub <noreply@github.com>2020-10-08 23:17:25 -0700
commitcd0e32ff9ec5d33d911832c1ea716acb900b564d (patch)
tree63cbbe387210a827094e312a8dcd744910d53c32 /keyboards/keyboardio/atreus/readme.md
parent7229997e7d7e3519c09774020c7f3979541ea761 (diff)
[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>
Diffstat (limited to 'keyboards/keyboardio/atreus/readme.md')
-rw-r--r--keyboards/keyboardio/atreus/readme.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/keyboards/keyboardio/atreus/readme.md b/keyboards/keyboardio/atreus/readme.md
new file mode 100644
index 0000000000..ab7dba14d7
--- /dev/null
+++ b/keyboards/keyboardio/atreus/readme.md
@@ -0,0 +1,31 @@
+# Keyboardio Atreus
+
+![Atreus](https://atreus.technomancy.us/i/atreus2-mug.jpg)
+
+A small mechanical keyboard that is based around the shape of the human hand.
+
+* Keyboard Maintainer: [Keyboardio](https://github.com/keyboardio)
+* Hardware Supported: Keyboardio Atreus
+* Hardware Availability: https://www.kickstarter.com/projects/keyboardio/atreus
+
+These configuration files are specifically for the Keyboardio Atreus, a
+collaboration between [Phil Hagelberg](https://github.com/technomancy) and
+[Keyboardio](https://github.com/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](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).