diff options
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 50901ee32..5cd797da9 100644 --- a/keyboards/atreus/readme.md +++ b/keyboards/atreus/readme.md | |||
| @@ -1,21 +1,24 @@ | |||
| 1 | Atreus | 1 | Atreus |
| 2 | === | 2 | ====== |
| 3 | 3 | ||
| 4 | A small mechanical keyboard that is based around the shape of the human hand. | 4 | A small mechanical keyboard that is based around the shape of the human hand. |
| 5 | 5 | ||
| 6 | 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. | ||
| 7 | |||
| 8 | Keyboard Maintainer: [Phil Hagelberg](https://github.com/technomancy) | 6 | Keyboard Maintainer: [Phil Hagelberg](https://github.com/technomancy) |
| 9 | Hardware Supported: Atreus, PCB-based or hand-wired | 7 | Hardware Supported: Atreus, PCB-based or hand-wired |
| 10 | Hardware Availability: https://atreus.technomancy.us | 8 | Hardware Availability: https://atreus.technomancy.us |
| 11 | 9 | ||
| 12 | Make example for this keyboard (after setting up your build environment): | 10 | 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. |
| 11 | |||
| 12 | A-Star:\ | ||
| 13 | `make atreus:default:avrdude` | ||
| 13 | 14 | ||
| 14 | make atreus:default:avrdude | 15 | Teensy:\ |
| 16 | `make TEENSY2=yes atreus:default:teensy` | ||
| 17 | |||
| 18 | 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. | ||
| 15 | 19 | ||
| 16 | Unlike the TMK firmware, this command should be run from the root of | 20 | `make PCBDOWN=yes atreus:default:avrdude` |
| 17 | the repository, not the directory containing this readme. | ||
| 18 | 21 | ||
| 19 | 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. | 22 | *Unlike the TMK firmware, these commands should be run from the root of the repository, not the directory containing this readme.* |
| 20 | 23 | ||
| 21 | 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. | 24 | 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. |
