big README change

Author: vi

README README.md

@@ -1,15 +1,32 @@
-Simple virtual input device to testing things in Linux. Creates character device and input device.
+# virtual_touchscreen
 
-Building (from configured Linux kernel's directory):
+Simple virtual input device for testing things in Linux. Creates a character device and an input device.
 
-"make modules M=~/src/virtual_touchscreen/"
+![screenshot](screenshot.png).
 
-Using:
 
-1# insmod virtual_touchscreen.ko
-1# dmesg | grep virtual_touchscreen
+# Building
+
+## module
+
+From a configured Linux kernel's directory:
+
+    make modules M=~/src/virtual_touchscreen/
+
+## application
+
+Use run `virtual_touchscreen.clj` or just use pre-built `virtual_touchscreen.jar` from Github releases
+
+# Using
+
+
+## Some testing
+
+```
+# insmod virtual_touchscreen.ko
+# dmesg | grep virtual_touchscreen
 virtual_touchscreen: Major=250
-1# cat /dev/virtual_touchscreen
+# cat /dev/virtual_touchscreen
 Usage: write the following commands to /dev/virtual_touchscreen:
     x num  - move to (x, ...)
     y num  - move to (..., y)
@@ -29,26 +46,36 @@ Usage: write the following commands to /dev/virtual_touchscreen:
   Each command is terminated with '\n'. Short writes == dropped commands.
   Read linux Documentation/input/multi-touch-protocol.txt to read about events
 
-1# printf 'x 200\ny 300\nS 0\n' > /dev/virtual_touchscreen
-1# printf 'd 0\nS 0\n' > /dev/virtual_touchscreen
-1# printf 'u 0\nS 0\n' > /dev/virtual_touchscreen
+# printf 'x 200\ny 300\nS 0\n' > /dev/virtual_touchscreen
+# printf 'd 0\nS 0\n' > /dev/virtual_touchscreen
+# printf 'u 0\nS 0\n' > /dev/virtual_touchscreen
+```
 
-2# hd /dev/input/event11 # or whatever udev assigns
+And events should flow from the newly created input device:
+
+```
+# hd /dev/input/event11 # or whatever udev assigns
 00000000  df 32 48 4f a6 10 02 00  03 00 00 00 c8 00 00 00  |.2HO............|
 00000010  df 32 48 4f ab 10 02 00  03 00 01 00 2c 01 00 00  |.2HO........,...|
 00000020  df 32 48 4f bf 10 02 00  00 00 00 00 00 00 00 00  |.2HO............|
 00000030  e3 32 48 4f af af 09 00  01 00 4a 01 01 00 00 00  |.2HO......J.....|
 00000040  e3 32 48 4f bc af 09 00  00 00 00 00 00 00 00 00  |.2HO............|
 00000050  e7 32 48 4f 3d bb 05 00  01 00 4a 01 00 00 00 00  |.2HO=.....J.....|
 00000060  e7 32 48 4f 50 bb 05 00  00 00 00 00 00 00 00 00  |.2HOP...........|
+```
+
+## GUI
 
-There is also experimental script to read /dev/input/eventX of some real device and output data for virtual_touchscreen.
+There is a GUI application that can also provide data for virtual touchscreen: `virtual_touchscreen.clj`. ([pre-built bundled version](https://vi-server.org/pub/virtual_touchscreen.jar); SHA256=917698e287e1b707e09c3040d6347f5f041d7a60fef0a6f5e51c2b93ccd39f3c, also available on Github Releases)
 
-There is GUI application that can also provide data for virtual touchscreen
-(virtual_touchscreen.clj, bundled version: https://vi-server.org/pub/virtual_touchscreen.jar , SHA256 (virtual_touchscreen.jar) = 917698e287e1b707e09c3040d6347f5f041d7a60fef0a6f5e51c2b93ccd39f3c)
 It listens port 9494 and provides virtual_touchscreen input for connected clients.
 
 Example:
-hostA$  java -cp clojure.jar clojure.main virtual_touchscreen.clj
 
-hostB#  nc hostA 9494 > /dev/virtual_touchscreen
+    hostA$  java -cp clojure.jar clojure.main virtual_touchscreen.clj
+
+    hostB#  nc hostA 9494 > /dev/virtual_touchscreen
+
+## Misc
+
+There is also experimental script to read `/dev/input/eventX` of some real device and output data for virtual_touchscreen. It is long unmaintained although. Maybe see forks for alternative script.