]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/atreus/readme.md
Merge pull request #1574 from danamlund/master
[qmk_firmware.git] / keyboards / atreus / readme.md
1 Atreus
2 ===
3
4 A small mechanical keyboard that is based around the shape of the human hand.
5
6 These configuration files are specifically for the Atreus keyboards created by Phil Hagelberg (@technomancy). This keyboard is available in two variants: one powered by a Teensy 2, one powered by an A-Star. This repository currently assumes that you have an A-Star powered Atreus. If you are using a Teensy2, specify that by adding `TEENSY2=yes` to your `make` commands.
7
8 If you are coming from the [atreus-firmware](https://github.com/technomancy/atreus-firmware), we've also brought forward the `make upload` command for you to use.
9
10 Keyboard Maintainer: QMK Community
11 Hardware Supported: Atreus PCB
12 Hardware Availability: https://atreus.technomancy.us
13
14 Make example for this keyboard (after setting up your build environment):
15
16     make atreus-default
17
18 See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.