diff options
-rw-r--r-- | keyboards/atreus/readme.md | 7 | ||||
-rw-r--r-- | readme.md | 3 |
2 files changed, 7 insertions, 3 deletions
diff --git a/keyboards/atreus/readme.md b/keyboards/atreus/readme.md index 221c7fac4..6a86ff2e0 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. | |||
5 | 5 | ||
6 | 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. | 6 | 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. |
7 | 7 | ||
8 | Keyboard Maintainer: QMK Community | 8 | Keyboard Maintainer: [Phil Hagelberg](https://github.com/technomancy) |
9 | Hardware Supported: Atreus PCB | 9 | Hardware Supported: Atreus, PCB-based or hand-wired |
10 | Hardware Availability: https://atreus.technomancy.us | 10 | Hardware Availability: https://atreus.technomancy.us |
11 | 11 | ||
12 | Make example for this keyboard (after setting up your build environment): | 12 | Make example for this keyboard (after setting up your build environment): |
13 | 13 | ||
14 | make atreus:default:avrdude | 14 | make atreus:default:avrdude |
15 | 15 | ||
16 | Unlike the TMK firmware, this command should be run from the root of | ||
17 | the repository, not the directory containing this readme. | ||
18 | |||
16 | 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. | 19 | 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. |
@@ -22,12 +22,13 @@ The docs are hosted on [Gitbook](https://www.gitbook.com/book/qmk/firmware/detai | |||
22 | * [ErgoDox EZ](/keyboards/ergodox_ez/) | 22 | * [ErgoDox EZ](/keyboards/ergodox_ez/) |
23 | * [Clueboard](/keyboards/clueboard/) | 23 | * [Clueboard](/keyboards/clueboard/) |
24 | * [Cluepad](/keyboards/clueboard/17/) | 24 | * [Cluepad](/keyboards/clueboard/17/) |
25 | * [Atreus](/keyboards/atreus/) | ||
25 | 26 | ||
26 | The project also includes community support for [lots of other keyboards](/keyboards/). | 27 | The project also includes community support for [lots of other keyboards](/keyboards/). |
27 | 28 | ||
28 | ## Maintainers | 29 | ## Maintainers |
29 | 30 | ||
30 | 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). | 31 | 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). |
31 | 32 | ||
32 | ## Official website | 33 | ## Official website |
33 | 34 | ||