aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOndrej Čerman2018-11-12 01:19:04 +0100
committerGitHub2018-11-12 01:19:04 +0100
commita710e870471c87f9a3c5340d71422574ca04e14c (patch)
tree0547535edfbe6201ea37154ed993eebbc43455c2 /README.md
parentba72ab76e44fe0582c63469e23ac0c5788a22398 (diff)
Create README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..850c29d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# Zenpower
+Zenpower is Linux kernel driver for reading temperature, voltage, current and power for AMD Zen family CPUs.
+
+## Installation
+You can install this module via dkms.
+
+### Installation commands for Ubuntu
+```
+sudo apt install dkms git build-essential linux-headers-$(uname -r)
+cd ~
+git clone https://github.com/ocerman/zenpower.git
+cd zenpower
+sudo make dkms-install
+```
+
+## Module activation
+Because zenpower is using same PCI device as k10temp, you have to disable k10temp first.
+
+1. Check if k10temp is active. `lsmod | grep k10temp`
+2. Unload k10temp `sudo modprobe -r k10temp`
+3. (optional) blacklist k10temp: `sudo bash -c 'sudo echo "blacklist k10temp" > /etc/modprobe.d/blacklist.conf'`
+4. Activate zenpower `sudo modprobe zenpower`
+
+## Sensors monitoring
+You can use this script: [zenmonitor](https://github.com/ocerman/zenmonitor), or your favourie sensors monitoring software