summaryrefslogtreecommitdiff
path: root/keyboard/atreus/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboard/atreus/README.md')
-rw-r--r--keyboard/atreus/README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/keyboard/atreus/README.md b/keyboard/atreus/README.md
index 75f198fd1c..e3bcaa4c4d 100644
--- a/keyboard/atreus/README.md
+++ b/keyboard/atreus/README.md
@@ -1,10 +1,6 @@
atreus keyboard firmware
======================
-## Note
-
-This is for the Teensy2 hand wired boards only.
-
## Quantum MK Firmware
You have access to a bunch of goodies! Check out the Makefile to enable/disable some of the features. Uncomment the `#` to enable them. Setting them to `no` does nothing and will only confuse future you.
@@ -14,6 +10,12 @@ You have access to a bunch of goodies! Check out the Makefile to enable/disable
# UNICODE_ENABLE = yes # Unicode support - this is commented out, just as an example. You have to use #, not //
BLUETOOTH_ENABLE = yes # Enable Bluetooth with the Adafruit EZ-Key HID
+## Atreus specific information
+
+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, one powered by an A-Star. This repository currently assumes that you have a Teensy 2 powered Atreus. If you are using an A-Star, specify that by adding `ASTAR=yes` to your `make` commands.
+
+If you are coming from the [atreus-firmware](https://github.com/technomancy/atreus-firmware), we've also brought forward the `make upload` command for you to use.
+
## Quick aliases to common actions
Your keymap can include shortcuts to common operations (called "function actions" in tmk).