keychron_qmk_firmware/keyboards/handwired/dactyl/readme.md
Erin Call b697e1bff3 Fix build instructions in the Dactyl readme
Reflects the changes in #1784
2017-11-26 17:56:16 -05:00

40 lines
1.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 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_<keymapname>.hex`
- If you like, you can do both at once: `make handwired/dactyl:<keymapname>:teensy`
- 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.