summaryrefslogtreecommitdiff
path: root/keyboards/handwired/dactyl/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/handwired/dactyl/readme.md')
-rw-r--r--keyboards/handwired/dactyl/readme.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/keyboards/handwired/dactyl/readme.md b/keyboards/handwired/dactyl/readme.md
new file mode 100644
index 000000000..f473b020e
--- /dev/null
+++ b/keyboards/handwired/dactyl/readme.md
@@ -0,0 +1,37 @@
+# Dactyl
+
+See https://github.com/adereth/dactyl-keyboard
+
+The Dactyl uses the [Teensy Loader](https://www.pjrc.com/teensy/loader.html).
+
+Linux users need to modify udev rules as described on the [Teensy
+Linux page]. Some distributions provide a binary, maybe called
+`teensy-loader-cli`.
+
+[Teensy Linux page]: https://www.pjrc.com/teensy/loader_linux.html
+
+To flash the firmware:
+
+ - Build the firmware with `make handwired-dactyl-keymapname`, for example `make handwired-dactyl-default`
+ - This will result in a hex file called `handwired_dactyl_keymapname.hex`, e.g.
+ `handwired_dactyl_default.hex`
+
+ - Start the teensy loader.
+
+ - Load the .hex file into it.
+
+ - Put the Teensy in firmware-loading mode:
+ * If your current layout has a RESET key, press it.
+ * If you lack a RESET key, press the reset button on the Teensy board itself.
+
+ - Click the button in the Teensy app to download the firmware.
+
+To flash with ´teensy-loader-cli´:
+
+ - Build the firmware as above
+
+ - Run `<path/to/>teensy_loader_cli -mmcu=atmega32u4 -w handwired_dactyl_<keymap>.hex`
+
+ - Put the Teensy in firmware-loading mode:
+ * If your current layout has a RESET key, press it.
+ * If you lack a RESET key, press the reset button on the Teensy board itself.