test build of 'Host shield' in minimal env.

[qmk_firmware.git] / protocol / usb_hid / README

diff --git a/protocol/usb_hid/README b/protocol/usb_hid/README
index 0acf677f8b6d8f1fc5bc9a26098c50e30a99f345..9750a1cc8d79b5eeb3dbfa6b0805ad6994069e8f 100644 (file)
--- a/protocol/usb_hid/README
+++ b/protocol/usb_hid/README
@@ -1,3 +1,8 @@
+USB HID protocol
+================
+Host side of USB HID keyboard protocol implementation.
+Only standard HID Boot mode is supported at this time. This means most of normal keyboards are supported while proprietary >6KRO and NKRO is not.
+
 Third party Libraries
 ---------------------
 USB_Host_Shield_2.0
@@ -7,3 +12,17 @@ USB_Host_Shield_2.0
 arduino-1.0.1
     Arduino files copied from:
     https://github.com/arduino/Arduino/hardware/arduino/{cores,variants}
+
+
+Test build
+----------
+In test directory;
+    $ make
+    $ DEV=/dev/ttyACM0 make program
+
+You can see HID keyboard reports on debug output.
+
+
+Restriction and Bug
+-------------------
+Not statble yet.