Skip to content

Commit a393cff

Browse files
authored
Merge pull request #116 from powerapi-ng/docs/update-readme-consortium
docs(README): Update project description
2 parents efdf5f6 + a3b71b6 commit a393cff

File tree

1 file changed

+6
-16
lines changed

1 file changed

+6
-16
lines changed

README.md

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,11 @@
11
# Hardware Performance Counters (HwPC) Sensor
2-
3-
HardWare Performance Counter (HWPC) Sensor is a tool that monitor the Intel CPU
4-
performance counter and the power consumption of CPU.
5-
6-
Hwpc-sensor use the RAPL (Running Average Power Limit) technology to monitor CPU
7-
power consumption. This technology is only available on Intel Sandy Bridge
8-
architecture or higher.
9-
10-
The sensor use the perf API of the Linux kernel. It is only available on Linux
11-
and need to have root access to be used.
12-
13-
The sensor couldn’t be used in a virtual machine, it must access (via Linux
14-
kernel API) to the real CPU register to read performance counter values.
2+
This project is a lightweight sensor that monitor the Hardware Performance Counters of the cgroups (i.e. containers, systemd units...) running on a Linux system.
153

164
# About
5+
This open-source project is maintained by the [PowerAPI consortium](https://github.com/powerapi-ng).
6+
To report bugs, submit feature ideas, or post feedback, please use the [Issues section](https://github.com/powerapi-ng/hwpc-sensor/issues) of this repo.
177

18-
HwPC sensor is an open-source project developed by the [Spirals research
19-
group](https://team.inria.fr/spirals) (University of Lille 1 and Inria).
8+
The documentation is available [on the PowerAPI website](http://powerapi.org).
209

21-
The documentation is available [here](http://powerapi.org)
10+
# License
11+
This project is licensed under the [BSD-3-Clause License](https://opensource.org/licenses/BSD-3-Clause).

0 commit comments

Comments
 (0)