qmk-firmware/keyboards/atreus/readme.md

Atreus
======

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

Keyboard Maintainer: [Phil Hagelberg](https://github.com/technomancy)  
Hardware Supported: Atreus, PCB-based or hand-wired  
Hardware Availability: https://atreus.technomancy.us

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 (usually hand-wired), one powered by an A-Star (usually using a PCB). You will need to use different `make` commands depending on the variant you have; see examples below.

A-Star:\
`make atreus:default:avrdude`

Teensy:\
`make TEENSY2=yes atreus:default:teensy`
 
If your keyboard layout is a mirror image of what you expected (i.e. you do not get QWERTY on the left but YTREWQ on the right), then you have an A-Star powered Atreus (older than March 2016) with PCB labels facing *down* instead of up. Specify that by adding `PCBDOWN=yes` to your `make` commands, e.g.

`make PCBDOWN=yes atreus:default:avrdude`

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

See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools), then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
Make the bulk of our keyboards match the readme.md standard 2017-08-17 00:08:16 +02:00			`Atreus`
Atreus rules.mk and readme (#5678) * Update rules and readme to reflect new make usage. * Minor edit. * Minor edit. 2019-04-22 17:15:56 +02:00			`======`
Add Teensy2 Atreus support 2016-01-30 05:30:33 +01:00
Make the bulk of our keyboards match the readme.md standard 2017-08-17 00:08:16 +02:00			`A small mechanical keyboard that is based around the shape of the human hand.`
Add support for Atreus running on A-Star 2016-01-03 23:49:28 +01:00
Add Atreus as an official board. 2018-08-16 17:47:36 +02:00			`Keyboard Maintainer: [Phil Hagelberg](https://github.com/technomancy)`
			`Hardware Supported: Atreus, PCB-based or hand-wired`
Make the bulk of our keyboards match the readme.md standard 2017-08-17 00:08:16 +02:00			`Hardware Availability: https://atreus.technomancy.us`
Add Teensy2 Atreus support 2016-01-30 05:30:33 +01:00
Atreus rules.mk and readme (#5678) * Update rules and readme to reflect new make usage. * Minor edit. * Minor edit. 2019-04-22 17:15:56 +02:00			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 (usually hand-wired), one powered by an A-Star (usually using a PCB). You will need to use different `make` commands depending on the variant you have; see examples below.

			`A-Star:\`
			`make atreus:default:avrdude`
Add Teensy2 Atreus support 2016-01-30 05:30:33 +01:00
Atreus rules.mk and readme (#5678) * Update rules and readme to reflect new make usage. * Minor edit. * Minor edit. 2019-04-22 17:15:56 +02:00			`Teensy:\`
			`make TEENSY2=yes atreus:default:teensy`

			If your keyboard layout is a mirror image of what you expected (i.e. you do not get QWERTY on the left but YTREWQ on the right), then you have an A-Star powered Atreus (older than March 2016) with PCB labels facing down instead of up. Specify that by adding `PCBDOWN=yes` to your `make` commands, e.g.
Update keyboard readme files with new makefile instructions 2016-08-20 02:22:16 +02:00
Atreus rules.mk and readme (#5678) * Update rules and readme to reflect new make usage. * Minor edit. * Minor edit. 2019-04-22 17:15:56 +02:00			`make PCBDOWN=yes atreus:default:avrdude`
Add Atreus as an official board. 2018-08-16 17:47:36 +02:00
Atreus rules.mk and readme (#5678) * Update rules and readme to reflect new make usage. * Minor edit. * Minor edit. 2019-04-22 17:15:56 +02:00			`Unlike the TMK firmware, these commands should be run from the root of the repository, not the directory containing this readme.`
Keyboard: Support PCBDOWN variants for Atreus keyboard (#3735) 2018-08-24 17:53:03 +02:00
Atreus rules.mk and readme (#5678) * Update rules and readme to reflect new make usage. * Minor edit. * Minor edit. 2019-04-22 17:15:56 +02:00			`See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools), then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.`