resolves conflicts in rgblight.c

[qmk_firmware.git] / keyboard / hhkb / README.md

diff --git a/keyboard/hhkb/README.md b/keyboard/hhkb/README.md
index f9fd1650766866eef21737275c00c04ee5c23221..e20c23d8236d886d4869e14e51678ee07b2ef281 100644 (file)
--- a/keyboard/hhkb/README.md
+++ b/keyboard/hhkb/README.md
@@ -10,11 +10,17 @@ See [this thread][AltController] in geekhack.org.
 [AltController]: http://geekhack.org/index.php?topic=12047.0
 
 
+## Update
+* Bluetooth module RN-42 is supported.(2015/01)
+* V-USB and iWRAP are no longer supported now, but still it'll works with a little fix. See not_supported directory.(2015/01)
+
+
 ##Features
 * Customizable keymap
 * More keymap layers(more Fn keys)
 * Mouse keys
 * USB NKRO
+* Bluetooth(RN-42)
 
 See README of [tmk_keyboard] for more.
 
@@ -50,8 +56,9 @@ If you use other than **TMK Alt Controller Board** set proper `MCU`, `BOOTLOADER
 ### 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 KEYMAP=[hasu|hhkb|spacefn|<name>]
-    $ make -f Makefile.jp KEYMAP=[jp|<name>]        # for HHKB JP
+    $ make -f Makefile.<jp|pjrc|rn42> KEYMAP=(hasu|hhkb|spacefn|<name>)
+
+You can omit `-f` option when you use `Makefile`. `Makefile` is used for **Pro2 and Pro**, `Makefile.jp` fits for **JP** model and `Makefile.rn42` supports Bluetooth module **RN-42**. `Makefile.pjrc` uses **PJRC** as output protocol instead of **LUFA**.
 
 
 ### Program
@@ -59,19 +66,17 @@ First, push reset button on board to start bootloader.
 
 This command programs the controller with [dfu-programmer] if the tool is installed and configured properly.
 
-    $ make dfu
-    $ make -f Makefile.jp dfu       # for HHKB JP
+    $ make -f Makefile.<variant> KEYMAP=<name> dfu
 
 Or you can also use [FLIP] command to program. Also the tool should be installed and configured properly. FLIP GUI application is also available.
 
-    $ make flip
-    $ make -f Makefile.jp flip      # for HHKB JP
+    $ make -f Makefile.<variant> KEYMAP=<name> flip
 
 Use [Teensy Loader] if your controller is Teensy/Teensy++.
 
 
 ##Keymap
-To define your own keymap create file named `keymap_<name>.c` and see [keymap document](../../doc/keymap.md) and existent keymap files.
+To define your own keymap create a file in the keymaps folder named `<name>.c` and see keymap document (you can find in top README.md) and existent keymap files.
 
 
 ##Hardware