Browse Source

Add Atreus as an official board.

Phil Hagelberg 6 years ago
parent
commit
15a73f4f64
2 changed files with 7 additions and 3 deletions
  1. 5 2
      keyboards/atreus/readme.md
  2. 2 1
      readme.md

+ 5 - 2
keyboards/atreus/readme.md

@@ -5,12 +5,15 @@ A small mechanical keyboard that is based around the shape of the human hand.
 
 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.
 
-Keyboard Maintainer: QMK Community  
-Hardware Supported: Atreus PCB  
+Keyboard Maintainer: [Phil Hagelberg](https://github.com/technomancy)  
+Hardware Supported: Atreus, PCB-based or hand-wired  
 Hardware Availability: https://atreus.technomancy.us
 
 Make example for this keyboard (after setting up your build environment):
 
     make atreus:default:avrdude
 
+Unlike the TMK firmware, this command should be run from the root of
+the repository, not the directory containing this readme.
+
 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.

+ 2 - 1
readme.md

@@ -22,12 +22,13 @@ The docs are hosted on [Gitbook](https://www.gitbook.com/book/qmk/firmware/detai
 * [ErgoDox EZ](/keyboards/ergodox_ez/)
 * [Clueboard](/keyboards/clueboard/)
 * [Cluepad](/keyboards/clueboard/17/)
+* [Atreus](/keyboards/atreus/)
 
 The project also includes community support for [lots of other keyboards](/keyboards/).
 
 ## Maintainers
 
-QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, [Hasu](https://github.com/tmk). The OLKB product firmwares are maintained by [Jack Humbert](https://github.com/jackhumbert), the Ergodox EZ by [Erez Zukerman](https://github.com/ezuk), and the Clueboard by [Zach White](https://github.com/skullydazed).
+QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, [Hasu](https://github.com/tmk). The OLKB product firmwares are maintained by [Jack Humbert](https://github.com/jackhumbert), the Ergodox EZ by [Erez Zukerman](https://github.com/ezuk), the Clueboard by [Zach White](https://github.com/skullydazed), and the Atreus by [Phil Hagelberg](https://github.com/technomancy).
 
 ## Official website