]> git.donarmstrong.com Git - qmk_firmware.git/commitdiff
Add Atreus as an official board.
authorPhil Hagelberg <phil@hagelb.org>
Thu, 16 Aug 2018 15:47:36 +0000 (08:47 -0700)
committerJack Humbert <jack.humb@gmail.com>
Thu, 16 Aug 2018 16:01:34 +0000 (12:01 -0400)
keyboards/atreus/readme.md
readme.md

index 221c7fac4aec017518d39ffe27cfa08287a26263..6a86ff2e0006a714876bc3764abe416629c804ea 100644 (file)
@@ -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.
index 859e3ed12f157c72e5d866fd169038dc50169187..6e6cfaa1bd101aba36b5e202011616f1ea8d3aee 100644 (file)
--- a/readme.md
+++ b/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