diff options
| author | Jason Koh <zazender@fastmail.fm> | 2019-04-23 01:15:56 +1000 |
|---|---|---|
| committer | MechMerlin <30334081+mechmerlin@users.noreply.github.com> | 2019-04-22 08:15:56 -0700 |
| commit | 76e78e8ca1a348e85b3e8f351fcb42d94a3634a4 (patch) | |
| tree | c689437596205ae55e040f3d559a8a3c7d7e658e /keyboards/atreus/readme.md | |
| parent | 4ecaa25f3e9ae1bd1b61bab52f6a46cbaf512ae8 (diff) | |
Atreus rules.mk and readme (#5678)
* Update rules and readme to reflect new make usage.
* Minor edit.
* Minor edit.
Diffstat (limited to 'keyboards/atreus/readme.md')
| -rw-r--r-- | keyboards/atreus/readme.md | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/keyboards/atreus/readme.md b/keyboards/atreus/readme.md index 50901ee328..5cd797da96 100644 --- a/keyboards/atreus/readme.md +++ b/keyboards/atreus/readme.md @@ -1,21 +1,24 @@ Atreus -=== +====== A small mechanical keyboard that is based around the shape of the human hand. -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) 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. - Keyboard Maintainer: [Phil Hagelberg](https://github.com/technomancy) Hardware Supported: Atreus, PCB-based or hand-wired Hardware Availability: https://atreus.technomancy.us -Make example for this keyboard (after setting up your build environment): +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 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. -Unlike the TMK firmware, this command should be run from the root of -the repository, not the directory containing this readme. +`make PCBDOWN=yes atreus:default:avrdude` -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. +*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 [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. |