From: Edmund Cape <edmund.cape@lucivia.com>
Date: Mon, 21 May 2018 15:06:20 +0000 (-0400)
Subject: updated README for hhkb to include a Quick-start section
X-Git-Url: https://git.friedersdorff.com/?a=commitdiff_plain;h=a28aa255b542e1e4af531c5cd0892820ef60bc9e;p=max%2Ftmk_keyboard.git

updated README for hhkb to include a Quick-start section
---

diff --git a/keyboard/hhkb/README.md b/keyboard/hhkb/README.md
index 70d9384d..25a428f1 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,56 @@ 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 the pre-assembled hhkb 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
+      *  English
+         * [hhkb with blue-tooth](http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?hhkb_rn42)
+         * [hhkb with USB-only](http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?hhkb)
+
+      *  JP
+         * [hhkb with blue-tooth](http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?hhkb_jp_rn42)
+         * [hhkb with 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<P>
+
+
+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` <P>
+   _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 concatenated sequence of commands <P>
+   ```
+   $ sleep 20 && dfu-programmer atmega32u4 erase --force && dfu-programmer atmega32u4 flash <your_downloaded_file>.hex  && dfu-programmer atmega32u4 reset
+   ```
+   * Run this command from the directory where you saved your `.hex` file
+   * `sleep 20` gives you time to switch your controller to a programmable mode
+     by hitting the red button located on your controller
+   * Once in this mode, you will no longer have access to your keyboard; that's
+     ok because the rest of the commands are concatenated together to run without
+     needing further input from the keyboard
+   * Once you switch the controller to the programmable state (by hitting the
+     red button), the `dfu-programmer` will automatically detect your controller (`man
+     dfu-controller` for details)
+   * `&& dfu-programmer...` are the concatenated commands that clear
+     the old, load the new and restart your controller with the new firmware.
+     These commands execute automatically once the ~ 20 seconds have passed.
+
+   * While this is not expected, in the event the bootloader fails to load
+     your `.hex` file, disconnect and reconnect your keyboard's USB to
+     re-establish the normal mode of operation required to troubleshoot.
+
+   * In the event of an issue, please submit an issue on github to help us
+     improve the documentation.
+
+
 
 ## HHKB Internals
 See [doc/HHKB.txt](doc/HHKB.txt) and files under [doc/](doc/) for internal of HHKB and this controller.
@@ -55,7 +105,7 @@ Build options and firmware settings are available in `Makefile` and `config.h` o
 To define your own keymap create file named `keymap_<name>.c` and see [keymap document](../../tmk_core/doc/keymap.md) and existent keymap files.
 
 
-### Build 
+### Build
 Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. Just `make` with `KEYMAP` option like:
 
     $ make -f Makefile.<variant> KEYMAP=<name> clean