keyboards/atreus/readme.md

   1 Atreus
   2 ======
   3
   4 A small mechanical keyboard that is based around the shape of the human hand.
   5
   6 Keyboard Maintainer: [Phil Hagelberg](https://github.com/technomancy)
   7 Hardware Supported: Atreus, PCB-based or hand-wired
   8 Hardware Availability: https://atreus.technomancy.us
   9
  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`
  14
  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.
  19
  20 `make PCBDOWN=yes atreus:default:avrdude`
  21
  22 *Unlike the TMK firmware, these commands should be run from the root of the repository, not the directory containing this readme.*
  23
  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.