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 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)
   9 Hardware Supported: Atreus, PCB-based or hand-wired
  10 Hardware Availability: https://atreus.technomancy.us
  11
  12 Make example for this keyboard (after setting up your build environment):
  13
  14     make atreus:default:avrdude
  15
  16 Unlike the TMK firmware, this command should be run from the root of
  17 the repository, not the directory containing this readme.
  18
  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.
  20
  21 See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.