Merge remote-tracking branch 'tmk/master' into cub_layout

[tmk_firmware.git] / converter / sun_usb / README

diff --git a/converter/sun_usb/README b/converter/sun_usb/README
index ee59fc757c5982d7b592c04780de9e02384afe46..276f6bfff81387b2312784f0bafe2d74e1bfbf86 100644 (file)
--- a/converter/sun_usb/README
+++ b/converter/sun_usb/README
@@ -77,3 +77,23 @@ Just use 'make'
     $ cd sun_usb
     $ make
 Then, load the binary to MCU with your favorite programmer.
+
+
+Sun commands
+------------
+You can send Sun protocol commands with TMK `Magic` key combo. By default `Magic` key is `LShift` + `RShift`, `LAlt` + `RAlt' or `LMeta` + `RMeta`.
+https://github.com/tmk/tmk_keyboard#magic-commands
+
+Following Sun specific commands are available. For example, to send 'Bell On' you can press `LShift` + `RShift` + `Up` keys simultaneously.
+
+```
+----- Sun converter Help -----
+Up:     Bell On
+Down:   Bell Off
+Left:   Click On
+Right:  Click Off
+PgUp:   LED all On
+PgDown: LED all On
+Insert: Layout
+Delete: Reset
+```