general improvements
[evhz] / README.md
index 840cff4952517596a29b832a1e3a1ffdff9a4db1..92035bac049e6eac098e61d9d66b1fe957cd0003 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,16 +1,19 @@
-evhz
-====
+# evhz
 
-Display the current mouse refresh rate under linux with evdev.
+Display the current mouse refresh rate under linux with evdev
 
 For information about polling rate, see https://wiki.archlinux.org/index.php/Mouse_Polling_Rate
 
-The program is just evhz.c. Compile and run:
+Just do ./run (run is very short and readable).
 
-    gcc -o evhz evhz.c
-    sudo ./evhz
+Nonverbose mode = -n, but you probably don't want that.
 
-Nonverbose mode = -n
+Reported average is for the last 64 samples, or as many as we have so far.
+
+There exists a kernel bug for USB ports which use the uhci_hcd driver,
+where a 1000 hz mouse will only read at 500hz, causing jittering:
+https://bugzilla.kernel.org/show_bug.cgi?id=60586. A workaround is to
+use USB ports that use the ehci-pci driver.
 
 Maintainer: Ian Kelling <ian@iankelling.org>