History

Jason Koh 76e78e8ca1 Atreus rules.mk and readme (#5678 ) * Update rules and readme to reflect new make usage. * Minor edit. * Minor edit.		2019-04-22 08:15:56 -07:00
..
keymaps
atreus.c
atreus.h
config.h
info.json
readme.md	Atreus rules.mk and readme (#5678 )	2019-04-22 08:15:56 -07:00
rules.mk	Atreus rules.mk and readme (#5678 )	2019-04-22 08:15:56 -07:00

readme.md

Atreus

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

Keyboard Maintainer: Phil Hagelberg
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, then the make instructions for more information.