mirror of https://github.com/openstenoproject/qmk synced 2024-11-14 20:44:38 +00:00

History

QMK Bot ede6122ac6 Merge remote-tracking branch 'origin/master' into develop		2021-10-16 05:34:23 +00:00
..
astar	Remove bootloader listings from rules.mk (#14330 )	2021-09-10 13:35:46 +10:00
astar_mirrored	Remove bootloader listings from rules.mk (#14330 )	2021-09-10 13:35:46 +10:00
feather	Move Bluetooth config to common_features.mk (#14404 )	2021-09-12 08:22:03 -07:00
keymaps	[Keymap] Update Miryoku (#14827 )	2021-10-15 22:33:45 -07:00
promicro	[Keyboad] Add VIA support for Atreus promicro (#13169 )	2021-10-10 17:24:45 -07:00
teensy2	Remove bootloader listings from rules.mk (#14330 )	2021-09-10 13:35:46 +10:00
atreus.c
atreus.h
config.h
info.json	Remove width, height and key_count from info.json (#14274 )	2021-09-12 14:04:56 +10:00
readme.md
rules.mk	Remove audio pin references in rules.mk (#14532 )	2021-09-21 20:04:03 +10: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.

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

make atreus:default:avrdude

If you would like to use one of the alternative controllers:

make atreus/astar:default:flash
make atreus/teensy2:default:flash
make atreus/promicro:default:flash

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 the build environment setup and the make instructions for more information. Brand new to QMK? Start with our Complete Newbs Guide.