]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/handwired/dactyl/readme.md
Remove/migrate action_get_macro()s from default keymaps (#5625)
[qmk_firmware.git] / keyboards / handwired / dactyl / readme.md
1 # Dactyl
2
3 See https://github.com/adereth/dactyl-keyboard
4
5 The Dactyl uses the [Teensy Loader](https://www.pjrc.com/teensy/loader.html).
6
7 Linux users need to modify udev rules as described on the [Teensy
8 Linux page].  Some distributions provide a binary, maybe called
9 `teensy-loader-cli`.
10
11 [Teensy Linux page]: https://www.pjrc.com/teensy/loader_linux.html
12
13 To flash the firmware:
14
15   - Build the firmware with `make handwired/dactyl:<keymapname>`, for example `make handwired/dactyl:default`
16   - This will result in a hex file called `handwired_dactyl_<keymapname>.hex`, e.g.
17     `handwired_dactyl_default.hex`
18
19   - Start the teensy loader.
20
21   - Load the .hex file into it.
22
23   - Put the Teensy in firmware-loading mode:
24     * If your current layout has a RESET key, press it.
25     * If you lack a RESET key, press the reset button on the Teensy board itself.
26
27   - Click the button in the Teensy app to download the firmware.
28
29 To flash with ´teensy-loader-cli´:
30
31   - Build the firmware as above
32
33   - Run `<path/to/>teensy_loader_cli -mmcu=atmega32u4 -w handwired_dactyl_<keymapname>.hex`
34
35   - If you like, you can do both at once: `make handwired/dactyl:<keymapname>:teensy`
36
37   - Put the Teensy in firmware-loading mode:
38     * If your current layout has a RESET key, press it.
39     * If you lack a RESET key, press the reset button on the Teensy board itself.