X-Git-Url: https://iankelling.org/git/?a=blobdiff_plain;f=README.md;h=13e8782d788596c3691cc800e078784ed1581870;hb=04261c1142b015c6995a1a635e5e8aa70bf873ca;hp=fe99c2928c66a2c8424fa367819c8a975543f058;hpb=d59682bd3edd893714f52694e82462747aee6655;p=evhz

diff --git a/README.md b/README.md
index fe99c29..13e8782 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,23 @@
-evhz
-====
+# evhz
 
-Display the current mouse refresh rate under evdev linux system.
+Show mouse refresh rate under linux + evdev
 
-It is sufficient to simply download evhz.c vs cloning the repo.
+For information about polling rate, see https://wiki.archlinux.org/index.php/Mouse_Polling_Rate
 
-To compile and run:
+Just do ./run (run is very short and readable).
 
-gcc -o evhz evhz.c
+Nonverbose mode = -n, but you probably don't want that.
 
-sudo ./evhz -v
+Reported average is for the last 64 samples, or as many as we have so far.
 
-Bugs, patches, requests, etc. are welcome.
+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>
+
+Bugs, patches, requests, feedback are welcome.
+
+Last tested 7/2016 on Debian testing. Still working great after several
+years.