qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

readme.md (1790B)

      1 # Atreus
      2 
      3 ![Atreus](https://atreus.technomancy.us/photos/1.jpg)
      4 
      5 A small mechanical keyboard that is based around the shape of the human hand.
      6 
      7 Keyboard Maintainer: [Phil Hagelberg](https://github.com/technomancy)  
      8 Hardware Supported: Atreus, PCB-based or hand-wired  
      9 Hardware Availability: https://atreus.technomancy.us
     10 
     11 These configuration files are specifically for the Atreus keyboards created by Phil Hagelberg (@technomancy). This keyboard is available in several variants: powered by a Teensy 2 or STM32F103C8T6 based MCU board (usually hand-wired), powered by an A-Star or ProMicro (usually using a PCB). You will need to use different `make` commands depending on the variant you have; see examples below.
     12 
     13 Make example for this keyboard (after setting up your build environment):
     14 
     15     make atreus:default:avrdude
     16 
     17 If you would like to use one of the alternative controllers:
     18 
     19     make atreus/astar:default:flash
     20     make atreus/teensy2:default:flash
     21     make atreus/promicro:default:flash
     22     make atreus/f103:default:flash
     23 
     24 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.
     25 
     26     make PCBDOWN=yes atreus:default:avrdude
     27 
     28 *Unlike the TMK firmware, these commands should be run from the root of the repository, not the directory containing this readme.*
     29 
     30 See 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).