aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOndrej Čerman2019-12-29 17:34:07 +0100
committerOndrej Čerman2019-12-29 17:34:07 +0100
commit600680d3ec25de8e6a7816447577ff3c2a5e185d (patch)
tree8447eef4a093448effdac6b533e6000134ab3f7f /README.md
parent495045ef2ac3c14e2eb2cf49b5c43a11ad5d247b (diff)
Makefile: Added option for app installation
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 22 insertions, 5 deletions
diff --git a/README.md b/README.md
index d4bdd34..c823858 100644
--- a/README.md
+++ b/README.md
@@ -5,14 +5,14 @@ It can monitor these values:
- CPU Temperature
- CPU Core (SVI2) Voltage, Current and Power
- SOC (SVI2) Voltage, Current and Power
- - Package and Core Power
+ - Package and Core Power (RAPL)
- Core Frequency (from OS)
![screenshot](screenshot.png)
## Dependencies
- [zenpower driver](https://github.com/ocerman/zenpower/) - For monitoring CPU temperature and SVI2 sensors
- - MSR driver - For monitoring Package/Core Power
+ - MSR driver - For monitoring Package/Core Power (RAPL)
Follow [zenpower README.md](https://github.com/ocerman/zenpower/blob/master/README.md) to install and activate zenpower module.
Enter `sudo modprobe msr` to enable MSR driver.
@@ -23,9 +23,25 @@ Make sure that GTK3 dev package and common build tools are installed.
make
```
-## Running
+## Launching
+You can launch app by `sudo ./zenmonitor`, or you can install it to your system and then launch it from your OS menu.
+
+Note: Because superuser privileges are usually needed to access data from MSR driver, you need to launch zenmonitor as root for monitoring CPU power usage (RAPL).
+
+## Installing
+By default, Zenmonitor will be installed to /usr/local.
+```
+sudo make install
+```
+
+To add menu item for launching zenpower as root (Polkit is required):
+```
+sudo make install-polkit
+```
+
+## Uninstalling
```
-sudo ./zenpower
+sudo make uninstall
```
## Setup on ubuntu
@@ -39,5 +55,6 @@ cd ~
git clone https://github.com/ocerman/zenmonitor
cd zenmonitor
make
-sudo ./zenmonitor
+sudo make install
+sudo make install-polkit
```