Document output format in README.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Signed-off-by: Henrik Rydberg <rydberg@euromail.se>

1 files changed, 21 insertions, 0 deletions

diff --git a/README b/README
index 8efb27d..f0e4951 100644
--- a/README
+++ b/README
@@ -6,6 +6,27 @@ data, create devices and replay data from kernel evdev devices.
 http://bitmath.org/code/evemu/
 Please send patches to: patches@bitmath.org
 
+evemu produces two different data formats, one for the device description
+and one for the device event data. hex data is without a 0x prefix.
+
+Device Description Format:
+    N: <device name>
+    I: <bustype (hex)> <vendor (hex)> <product (hex)> <version (hex)>
+    # for each kernel property (2.3.38 only)
+    P: <byte 0 (hex)> <byte 1 (hex)> ... <byte 7 (hex)>
+    P: <byte 8 (hex)> ...
+    # for each index from 0 to EV_CNT
+    B: <index (hex)> <byte 0 (hex)> <byte 1 (hex)> ... <byte 7 (hex)>
+    B: <index (hex)> <byte 8 (hex)> ...
+    # for each absolute axis
+    A: <index (hex)> <min> <max> <fuzz> <flat>
+
+
+Event Data Format:
+    E: <sec>.<usec> <evtype (hex)> <evcode (hex)> <ev value>
+where type, code and value are the respective fields of the
+input_event struct defined in linux/input.h
+
 ---
 Copyright (C) 2010 Henrik Rydberg <rydberg@euromail.se>
 Copyright (C) 2010 Canonical Ltd.