diff options
Diffstat (limited to 'keyboards/atreus/readme.md')
| -rw-r--r-- | keyboards/atreus/readme.md | 30 |
1 files changed, 0 insertions, 30 deletions
diff --git a/keyboards/atreus/readme.md b/keyboards/atreus/readme.md deleted file mode 100644 index 84c541e8d5..0000000000 --- a/keyboards/atreus/readme.md +++ /dev/null @@ -1,30 +0,0 @@ -# Atreus - - - -A small mechanical keyboard that is based around the shape of the human hand. - -Keyboard Maintainer: [Phil Hagelberg](https://github.com/technomancy) -Hardware Supported: Atreus, PCB-based or hand-wired -Hardware Availability: https://atreus.technomancy.us - -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. - -Make example for this keyboard (after setting up your build environment): - - make atreus:default:avrdude - -If you would like to use one of the alternative controllers: - - make atreus/astar:default:flash - make atreus/teensy2:default:flash - make atreus/promicro:default:flash - make atreus/f103:default:flash - -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. - - make PCBDOWN=yes atreus:default:avrdude - -*Unlike the TMK firmware, these commands should be run from the root of the repository, not the directory containing this readme.* - -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). |