aboutsummaryrefslogtreecommitdiff
path: root/keyboards/atreus/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/atreus/readme.md')
-rw-r--r--keyboards/atreus/readme.md22
1 files changed, 13 insertions, 9 deletions
diff --git a/keyboards/atreus/readme.md b/keyboards/atreus/readme.md
index 5cd797da9..0dbd098ca 100644
--- a/keyboards/atreus/readme.md
+++ b/keyboards/atreus/readme.md
@@ -1,5 +1,6 @@
1Atreus 1# Atreus
2====== 2
3![Atreus](https://atreus.technomancy.us/photos/1.jpg)
3 4
4A small mechanical keyboard that is based around the shape of the human hand. 5A small mechanical keyboard that is based around the shape of the human hand.
5 6
@@ -9,16 +10,19 @@ Hardware Availability: https://atreus.technomancy.us
9 10
10These 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. 11These 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
12A-Star:\ 13Make example for this keyboard (after setting up your build environment):
13`make atreus:default:avrdude` 14
15 make atreus:default:avrdude
16
17If you would like to use one of the alternative controllers:
18
19 make atreus/astar:default:avrdude
20 make atreus/teensy2:default:teensy
14 21
15Teensy:\
16`make TEENSY2=yes atreus:default:teensy`
17
18If 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. 22If 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.
19 23
20`make PCBDOWN=yes atreus:default:avrdude` 24 make PCBDOWN=yes atreus:default:avrdude
21 25
22*Unlike the TMK firmware, these commands should be run from the root of the repository, not the directory containing this readme.* 26*Unlike the TMK firmware, these commands should be run from the root of the repository, not the directory containing this readme.*
23 27
24See [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. 28See 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).