ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update Atreus to current code conventions (#5849)

Browse source 
* Update atreus to current code conventions - add multi revision instead of defines

* Remove config.h duplication from user keymaps

* Add breaking change log

* Add missing pragma once
This commit is contained in:
Joel Challis 2019-08-02 21:35:35 +01:00 • committed by skullydazed
parent 3619678b10
commit 75ee8df19e
17 changed files with 346 additions and 378 deletions
Download patch file Download diff file Expand all files Collapse all files

22
keyboards/atreus/readme.md
View file

@ -1,5 +1,6 @@
Atreus
======
# Atreus
![Atreus](https://atreus.technomancy.us/photos/1.jpg)
A small mechanical keyboard that is based around the shape of the human hand.
@ -9,16 +10,19 @@ 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`
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:avrdude
make atreus/teensy2:default:teensy
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`
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.
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).