Merge pull request #176 from Mani-D/pmuDocUpdate

Updated documenatation with instructions on PMU usage

README.md

@@ -375,6 +375,11 @@ In reports with multiple benchmarks, the reference benchmark can be change by us
 
 ## Hardware performance counters <a name="pmc"></a>
 
+Xpedite uses linux perf events api to program and collect hardware performance counters in the cpu.
+To enable this feature, ensure cpu level event access is permitted for the current user running Xpedite.
+Cpu level event access for all users can be enabled by setting /proc/sys/kernel/perf_event_paranoid to a value <=0.
+More details can found at perf_event_paranoid section of the linux kernel documentation [here](https://www.kernel.org/doc/Documentation/sysctl/kernel.txt)
+
 Xpedite can collect any of the core and offcore hardware performance counters, for bottleneck or topdown analysis.
 The list of counters supported, depends on processor's micro architecture and can be listed by running ```xpedite list```
 

ko/README.md

@@ -1,3 +1,12 @@
+# Xpedite kernel module is deprecated
+
+Xpedite no longer requires kernel module to use hardware performance counters.
+Xpedite now uses perf events api to program and collect PMU data from user space.
+
+For more details checkout the section on "Hardware performance counters" in Xpedite readme docs.
+
+
+
 # Xpedite kernel module
 
 Xpedite provides a minimalistic kernel module to support programming and collection of performance counters from user space.