X-Git-Url: https://git.friedersdorff.com/?a=blobdiff_plain;f=keyboard%2Fhhkb%2FREADME.md;h=1eb1b426e29cd32aa948ff1187e8df1efa54b321;hb=d987783c1a28274a2bb35ce59f1de71f143dc0c0;hp=70d9384d056d1581c54154b6c70943647e47928c;hpb=09d380d31366d3f965b376031964bfd76526f018;p=max%2Ftmk_keyboard.git diff --git a/keyboard/hhkb/README.md b/keyboard/hhkb/README.md index 70d9384d..1eb1b426 100644 --- a/keyboard/hhkb/README.md +++ b/keyboard/hhkb/README.md @@ -24,7 +24,7 @@ See [this thread][AltController] in geekhack.org for details. See README of [tmk_keyboard] for more. [tmk_keyboard]: http://github.com/tmk/tmk_keyboard - + ### Pros * No risks: Everything is all reversible * No need for PCB trace patching, case cutting or any other destructive mod @@ -39,6 +39,60 @@ See README of [tmk_keyboard] for more. I'm not a professional of electronics nor MCU programming. This may damage your HHKB. And my English writing is poor, I'm not sure I can convey my notions accurately. +## Quick-Start Guide for TMK Alt Controller +1. Build a custom keyboard layout using the online tool + * Use Chrome if the site does not behave as expected + * Make sure to generate the file using the right template + * Pro2/Pro + * [Bluetooth](http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?hhkb_rn42) + * [USB-only](http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?hhkb) + + * JP + * [Bluetooth](http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?hhkb_jp_rn42) + * [USB-only](http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?hhkb_jp) + +1. Save the `.hex` file to your computer; note this is all you need to generate + a custom layout with most of the available features (including mouse control) + * Check-out [the last third of this video](https://www.youtube.com/watch?v=TYmAb8zOPWU&t=561s) + to get an idea of how to build your own layout; it includes how to load to the firmware using FLIP
+ + +1. Download and install the `dfu-programmer` (the alternative to FLIP), open-source available + for Windows, Linux, and Mac OS. e.g., for Mac OS: `brew install dfu-programmer`
+ _Note: This bootloader is all that is required to load/flash the firmware created
+ using the online tool. You do not need the full `avr-gcc` development stack
+ because you created the required `.hex` file using the online tool instead._
+
+1. Please read and understand this next step in full before running the
+ following three commands
+
+ ```
+ dfu-programmer atmega32u4 erase --force
+ dfu-programmer atmega32u4 flash