doc update
[evhz] / README.md
index fb327b1b5cc8d406fbf07cf5a0f4cff144482d78..b8579e4476e1f72d97bd5ae5bfdc2799639f8eb2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,3 +2,17 @@ evhz
 ====
 
 Display the current mouse refresh rate under evdev linux system.
+
+For information about polling rate, see https://wiki.archlinux.org/index.php/Mouse_Polling_Rate
+
+The program is just evhz.c. Compile and run:
+
+    gcc -o evhz evhz.c
+    sudo ./evhz
+
+Nonverbose mode = -n
+
+Maintainer: Ian Kelling <ian@iankelling.org>
+Bugs, patches, requests, feedback is welcome.
+
+Last tested 7/2014 on Fedora 20. Still working great. 
\ No newline at end of file