summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhil Hagelberg <phil@hagelb.org>2018-08-16 08:47:36 -0700
committerJack Humbert <jack.humb@gmail.com>2018-08-16 12:01:34 -0400
commit15a73f4f64a3b2b109e63cf1eeb37c9875c3d870 (patch)
treec0466793da9f0f5e8d5dc78c519b8e0767771c76
parent4044c746d0461271f15690150f874616f372511b (diff)
Add Atreus as an official board.
-rw-r--r--keyboards/atreus/readme.md7
-rw-r--r--readme.md3
2 files changed, 7 insertions, 3 deletions
diff --git a/keyboards/atreus/readme.md b/keyboards/atreus/readme.md
index 221c7fac4a..6a86ff2e00 100644
--- a/keyboards/atreus/readme.md
+++ b/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.
diff --git a/readme.md b/readme.md
index 859e3ed12f..6e6cfaa1bd 100644
--- 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