From caf8b7d703acf93c515d37bad82c2f45a8c9291d Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Mon, 23 May 2022 09:29:42 -0400
Subject: [PATCH 01/17] Formatted Header
---
README.md | 14 +++++++++++++-
1 file changed, 13 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index f91bb66..e12bd6c 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,17 @@
+
# Zenpower
-Zenpower is Linux kernel driver for reading temperature, voltage(SVI2), current(SVI2) and power(SVI2) for AMD Zen family CPUs.
+
+*Linux kernel Driver AMD Zen Family CPUs*
+
+
+
+## Readings
+
+- ***Temperature***
+- ***Voltage*** ( SVI2 )
+- ***Current*** ( SVI2 )
+- ***Power*** ( SVI2 )
+
Make sure that your Linux kernel have support for your CPUs as Zenpower is using kernel function `amd_smn_read` to read values from SMN. A fallback method (which may or may not work!) will be used when it is detected that kernel function `amd_smn_read` lacks support for your CPU.
For AMD family 17h Model 70h (Ryzen 3000) CPUs you need kernel version 5.3.4 or newer or kernel with this patch: https://patchwork.kernel.org/patch/11043277/
From 0af0d197932646b9e5b256ca363de15650e7aad3 Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Mon, 23 May 2022 09:32:32 -0400
Subject: [PATCH 02/17] Formatted Installation
---
README.md | 26 +++++++++++++++++++++++---
1 file changed, 23 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index e12bd6c..423c0f5 100644
--- a/README.md
+++ b/README.md
@@ -16,18 +16,32 @@
Make sure that your Linux kernel have support for your CPUs as Zenpower is using kernel function `amd_smn_read` to read values from SMN. A fallback method (which may or may not work!) will be used when it is detected that kernel function `amd_smn_read` lacks support for your CPU.
For AMD family 17h Model 70h (Ryzen 3000) CPUs you need kernel version 5.3.4 or newer or kernel with this patch: https://patchwork.kernel.org/patch/11043277/
+
+
## Installation
-You can install this module via dkms.
-### Installation commands for Ubuntu
+*You can install this module via `dkms`.*
+
+### ![Badge Ubuntu]
+
```
-sudo apt install dkms git build-essential linux-headers-$(uname -r)
+sudo apt install \
+ linux-headers-$(uname -r) \
+ build-essential \
+ dkms \
+ git
+
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.
@@ -56,3 +70,9 @@ It would be very helpful for me for further development of Zenpower if you can s
- Some users reported that a restart is needed after module installation
- If you are having trouble compiling zenpower under Ubuntu 18.04 (or older) with new upstream kernel, see [#23](https://github.com/ocerman/zenpower/issues/23)
- The meaning of raw current values from SVI2 telemetry are not standardised so the current/power readings may not be accurate on all systems (depends on the board model).
+
+
+
+
+
+[Badge Ubuntu]: https://img.shields.io/badge/Ubuntu-E95420?style=for-the-badge
From 94116851c5c5a8889cfada03ae87eb7f96dfd0a0 Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Mon, 23 May 2022 09:37:26 -0400
Subject: [PATCH 03/17] Formatted Activation
---
README.md | 48 ++++++++++++++++++++++++++++++++++++++++--------
1 file changed, 40 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 423c0f5..f834eb3 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
-# Zenpower
+# ZenPower
*Linux kernel Driver AMD Zen Family CPUs*
@@ -16,12 +16,15 @@
Make sure that your Linux kernel have support for your CPUs as Zenpower is using kernel function `amd_smn_read` to read values from SMN. A fallback method (which may or may not work!) will be used when it is detected that kernel function `amd_smn_read` lacks support for your CPU.
For AMD family 17h Model 70h (Ryzen 3000) CPUs you need kernel version 5.3.4 or newer or kernel with this patch: https://patchwork.kernel.org/patch/11043277/
+
## Installation
*You can install this module via `dkms`.*
+
+
### ![Badge Ubuntu]
```
@@ -41,16 +44,45 @@ sudo make dkms-install
```
+
+
+## Activation
+
+Because **ZenPower** is using same **PCI** device
+as `k10temp`, you have to disable it first.
+
+1. Check if the device is active:
-## Module activation
-Because zenpower is using same PCI device as k10temp, you have to disable k10temp first.
+ ```sh
+ lsmod | grep k10temp
+ ```
-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 -e "\n# replaced with zenpower\nblacklist k10temp" >> /etc/modprobe.d/blacklist.conf'`
-4. Activate zenpower `sudo modprobe zenpower`
+2. If active, unload it with:
-*If k10temp is not blacklisted, you may have to manually unload k10temp after each restart.
+ ```sh
+ sudo modprobe -r k10temp
+ ```
+
+3. Blacklist the device:
+
+ ```sh
+ sudo bash -c 'sudo echo -e "\n# replaced with zenpower\nblacklist k10temp" >> /etc/modprobe.d/blacklist.conf'
+ ```
+
+ #### Optional
+
+ *If k10temp is not blacklisted, you may have to*
+ *manually unload k10temp after each restart.*
+
+
+4. Activate **ZenPower** with:
+
+ ```sh
+ sudo modprobe zenpower
+ ```
+
+
+
## Sensors monitoring
You can use this app: [zenmonitor](https://github.com/ocerman/zenmonitor), or your favourie sensors monitoring software
From b944f4c6d6854d68fbd1c877e2e28606d0c6f508 Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Mon, 23 May 2022 09:41:28 -0400
Subject: [PATCH 04/17] Formatted Updating
---
README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++--------
1 file changed, 53 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index f834eb3..74a61b3 100644
--- a/README.md
+++ b/README.md
@@ -51,17 +51,23 @@ sudo make dkms-install
Because **ZenPower** is using same **PCI** device
as `k10temp`, you have to disable it first.
+
+
1. Check if the device is active:
```sh
lsmod | grep k10temp
```
+
+
2. If active, unload it with:
```sh
sudo modprobe -r k10temp
```
+
+
3. Blacklist the device:
@@ -74,6 +80,7 @@ as `k10temp`, you have to disable it first.
*If k10temp is not blacklisted, you may have to*
*manually unload k10temp after each restart.*
+
4. Activate **ZenPower** with:
@@ -84,16 +91,51 @@ as `k10temp`, you have to disable it first.
-## Sensors monitoring
-You can use this app: [zenmonitor](https://github.com/ocerman/zenmonitor), or your favourie sensors monitoring software
+## Monitoring
+
+You can use the **[ZenMonitor]** or your
+favorite sensor monitoring software.
+
+
+
+
+## Updating
+
+1. Unload **ZenPower**:
+
+ ```sh
+ sudo modprobe -r zenpower
+ ```
+
+2. Navigate to its folder:
+
+ ```sh
+ cd ~/zenpower
+ ```
+
+3. Uninstall the old version:
+
+ ```sh
+ sudo make dkms-uninstall
+ ```
+
+4. Update the code from git
+
+ ```
+ git pull
+ ```
+
+5. Install the new version:
-## Update instructions
-1. Unload zenpower `sudo modprobe -r zenpower`
-2. Goto zenpower directory `cd ~/zenpower`
-3. Uninstall old version `sudo make dkms-uninstall`
-4. Update code from git `git pull`
-5. Install new version `sudo make dkms-install`
-6. Activate zenpower `sudo modprobe zenpower`
+ ```
+ sudo make dkms-install
+ ```
+
+6. Activate **Zenpower**:
+
+ ```
+ sudo modprobe zenpower
+ ```
## Help needed
It would be very helpful for me for further development of Zenpower if you can share debug data from zenpower. [Read more](https://github.com/ocerman/zenpower/issues/12)
@@ -108,3 +150,5 @@ It would be very helpful for me for further development of Zenpower if you can s
[Badge Ubuntu]: https://img.shields.io/badge/Ubuntu-E95420?style=for-the-badge
+
+[ZenMonitor]: https://github.com/ocerman/zenmonitor
\ No newline at end of file
From 4ccff0f823c1b27dfb4cec814587ef134ac50106 Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Mon, 23 May 2022 09:48:55 -0400
Subject: [PATCH 05/17] Formatted README
---
README.md | 30 ++++++++++++++++++++++++------
1 file changed, 24 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 74a61b3..87d7417 100644
--- a/README.md
+++ b/README.md
@@ -137,13 +137,29 @@ favorite sensor monitoring software.
sudo modprobe zenpower
```
-## Help needed
-It would be very helpful for me for further development of Zenpower if you can share debug data from zenpower. [Read more](https://github.com/ocerman/zenpower/issues/12)
+
+
+
+## Help Wanted
+
+It is greatly appreciated if you **[Share Debug Data]**
+of **ZenPower** to help future development efforts.
+
+
+
## Notes
- - Some users reported that a restart is needed after module installation
- - If you are having trouble compiling zenpower under Ubuntu 18.04 (or older) with new upstream kernel, see [#23](https://github.com/ocerman/zenpower/issues/23)
- - The meaning of raw current values from SVI2 telemetry are not standardised so the current/power readings may not be accurate on all systems (depends on the board model).
+
+ - Some users have reported that a restart
+ was necessary after module installation.
+
+ - If you are having trouble compiling **ZenPower** under
+ `Ubuntu 18.04+` with new upstream kernel, see [#23].
+
+ - The meaning of raw current values from **SVI2**
+ telemetry are not standardized so the current
+ and power readings may not be accurate on
+ all systems (depends on the board model).
@@ -151,4 +167,6 @@ It would be very helpful for me for further development of Zenpower if you can s
[Badge Ubuntu]: https://img.shields.io/badge/Ubuntu-E95420?style=for-the-badge
-[ZenMonitor]: https://github.com/ocerman/zenmonitor
\ No newline at end of file
+[Share Debug Data]: https://github.com/ocerman/zenpower/issues/12
+[ZenMonitor]: https://github.com/ocerman/zenmonitor
+[#23]: https://github.com/ocerman/zenpower/issues/23
From 11a6739aed2579d23325a2c0da3758159adb5132 Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Mon, 23 May 2022 09:57:45 -0400
Subject: [PATCH 06/17] Formatted Requirements
---
README.md | 21 +++++++++++++++++++--
1 file changed, 19 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 87d7417..7bfbf79 100644
--- a/README.md
+++ b/README.md
@@ -12,9 +12,25 @@
- ***Current*** ( SVI2 )
- ***Power*** ( SVI2 )
+
+
+
+## Requirements
+
+- Your **Linux Kernel** must support your **CPU**.
+
+ ***ZenPower*** *reads values from **SMN** with*
+ *the kernel function:* `amd_smn_read`
+
+ *There is a fallback, however*
+ *it is not guaranteed to work.*
+
+- `AMD Ryzen 3000 CPUs`
+
+ Family: `17h`
+ Model: `70h`
-Make sure that your Linux kernel have support for your CPUs as Zenpower is using kernel function `amd_smn_read` to read values from SMN. A fallback method (which may or may not work!) will be used when it is detected that kernel function `amd_smn_read` lacks support for your CPU.
-For AMD family 17h Model 70h (Ryzen 3000) CPUs you need kernel version 5.3.4 or newer or kernel with this patch: https://patchwork.kernel.org/patch/11043277/
+ Require a `5.3.4+` kernel or a **[Patched]** one.
@@ -169,4 +185,5 @@ of **ZenPower** to help future development efforts.
[Share Debug Data]: https://github.com/ocerman/zenpower/issues/12
[ZenMonitor]: https://github.com/ocerman/zenmonitor
+[Patched]: https://patchwork.kernel.org/patch/11043277/
[#23]: https://github.com/ocerman/zenpower/issues/23
From 69d52937d8ec04acef9bab7539d06c1f81e42704 Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Mon, 23 May 2022 09:59:15 -0400
Subject: [PATCH 07/17] Added License Badge
---
README.md | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 7bfbf79..8bf5155 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
-# ZenPower
+# ZenPower [![Badge License]][License]
*Linux kernel Driver AMD Zen Family CPUs*
@@ -25,7 +25,7 @@
*There is a fallback, however*
*it is not guaranteed to work.*
-- `AMD Ryzen 3000 CPUs`
+- `AMD Ryzen 3000` CPUs
Family: `17h`
Model: `70h`
@@ -181,8 +181,11 @@ of **ZenPower** to help future development efforts.
+[Badge License]: https://img.shields.io/badge/License-GPL_2-blue.svg?style=for-the-badge
[Badge Ubuntu]: https://img.shields.io/badge/Ubuntu-E95420?style=for-the-badge
+[License]: LICENSE
+
[Share Debug Data]: https://github.com/ocerman/zenpower/issues/12
[ZenMonitor]: https://github.com/ocerman/zenmonitor
[Patched]: https://patchwork.kernel.org/patch/11043277/
From 2e82f92784705e1c362e369824316f88ced17540 Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Mon, 23 May 2022 10:03:56 -0400
Subject: [PATCH 08/17] Separated Documentation
---
Documentation/Activate.md | 49 +++++++++++++++++
Documentation/Install.md | 31 +++++++++++
Documentation/Update.md | 42 ++++++++++++++
README.md | 113 --------------------------------------
4 files changed, 122 insertions(+), 113 deletions(-)
create mode 100644 Documentation/Activate.md
create mode 100644 Documentation/Install.md
create mode 100644 Documentation/Update.md
diff --git a/Documentation/Activate.md b/Documentation/Activate.md
new file mode 100644
index 0000000..a6e41a8
--- /dev/null
+++ b/Documentation/Activate.md
@@ -0,0 +1,49 @@
+
+# Activation
+
+Because **ZenPower** is using same **PCI** device
+as **[k10temp]**, you have to disable it first.
+
+
+
+1. Check if the device is active:
+
+ ```sh
+ lsmod | grep k10temp
+ ```
+
+
+
+2. If active, unload it with:
+
+ ```sh
+ sudo modprobe -r k10temp
+ ```
+
+
+
+3. Blacklist the device:
+
+ ```sh
+ sudo bash -c 'sudo echo -e "\n# replaced with zenpower\nblacklist k10temp" >> /etc/modprobe.d/blacklist.conf'
+ ```
+
+ #### Optional
+
+ *If **[k10temp]** is not blacklisted, you may have to*
+ *manually unload k10temp after each restart.*
+
+
+
+4. Activate **ZenPower** with:
+
+ ```sh
+ sudo modprobe zenpower
+ ```
+
+
+
+
+
+
+[k10temp]: https://github.com/groeck/k10temp
\ No newline at end of file
diff --git a/Documentation/Install.md b/Documentation/Install.md
new file mode 100644
index 0000000..c52254a
--- /dev/null
+++ b/Documentation/Install.md
@@ -0,0 +1,31 @@
+
+# Installation
+
+*You can install this module via `dkms` .*
+
+
+
+## ![Badge Ubuntu]
+
+```
+sudo apt install \
+ linux-headers-$(uname -r) \
+ build-essential \
+ dkms \
+ git
+
+cd ~
+
+git clone https://github.com/ocerman/zenpower.git
+
+cd zenpower
+
+sudo make dkms-install
+```
+
+
+
+
+
+
+[Badge Ubuntu]: https://img.shields.io/badge/Ubuntu-E95420?style=for-the-badge
\ No newline at end of file
diff --git a/Documentation/Update.md b/Documentation/Update.md
new file mode 100644
index 0000000..fc2bbe1
--- /dev/null
+++ b/Documentation/Update.md
@@ -0,0 +1,42 @@
+
+# Updating
+
+
+
+1. Unload **ZenPower**:
+
+ ```sh
+ sudo modprobe -r zenpower
+ ```
+
+2. Navigate to its folder:
+
+ ```sh
+ cd ~/zenpower
+ ```
+
+3. Uninstall the old version:
+
+ ```sh
+ sudo make dkms-uninstall
+ ```
+
+4. Update the code from git
+
+ ```
+ git pull
+ ```
+
+5. Install the new version:
+
+ ```
+ sudo make dkms-install
+ ```
+
+6. Activate **Zenpower**:
+
+ ```
+ sudo modprobe zenpower
+ ```
+
+
\ No newline at end of file
diff --git a/README.md b/README.md
index 8bf5155..43c8b5f 100644
--- a/README.md
+++ b/README.md
@@ -32,77 +32,6 @@
Require a `5.3.4+` kernel or a **[Patched]** one.
-
-
-
-## Installation
-
-*You can install this module via `dkms`.*
-
-
-
-### ![Badge Ubuntu]
-
-```
-sudo apt install \
- linux-headers-$(uname -r) \
- build-essential \
- dkms \
- git
-
-cd ~
-
-git clone https://github.com/ocerman/zenpower.git
-
-cd zenpower
-
-sudo make dkms-install
-```
-
-
-
-
-## Activation
-
-Because **ZenPower** is using same **PCI** device
-as `k10temp`, you have to disable it first.
-
-
-
-1. Check if the device is active:
-
- ```sh
- lsmod | grep k10temp
- ```
-
-
-
-2. If active, unload it with:
-
- ```sh
- sudo modprobe -r k10temp
- ```
-
-
-
-3. Blacklist the device:
-
- ```sh
- sudo bash -c 'sudo echo -e "\n# replaced with zenpower\nblacklist k10temp" >> /etc/modprobe.d/blacklist.conf'
- ```
-
- #### Optional
-
- *If k10temp is not blacklisted, you may have to*
- *manually unload k10temp after each restart.*
-
-
-
-4. Activate **ZenPower** with:
-
- ```sh
- sudo modprobe zenpower
- ```
@@ -115,47 +44,6 @@ favorite sensor monitoring software.
-## Updating
-
-1. Unload **ZenPower**:
-
- ```sh
- sudo modprobe -r zenpower
- ```
-
-2. Navigate to its folder:
-
- ```sh
- cd ~/zenpower
- ```
-
-3. Uninstall the old version:
-
- ```sh
- sudo make dkms-uninstall
- ```
-
-4. Update the code from git
-
- ```
- git pull
- ```
-
-5. Install the new version:
-
- ```
- sudo make dkms-install
- ```
-
-6. Activate **Zenpower**:
-
- ```
- sudo modprobe zenpower
- ```
-
-
-
-
## Help Wanted
It is greatly appreciated if you **[Share Debug Data]**
@@ -182,7 +70,6 @@ of **ZenPower** to help future development efforts.
[Badge License]: https://img.shields.io/badge/License-GPL_2-blue.svg?style=for-the-badge
-[Badge Ubuntu]: https://img.shields.io/badge/Ubuntu-E95420?style=for-the-badge
[License]: LICENSE
From d9e58e9bc45f6630543fa0be13434b7b735f3ff5 Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Mon, 23 May 2022 10:07:56 -0400
Subject: [PATCH 09/17] Added Quicklinks
---
README.md | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/README.md b/README.md
index 43c8b5f..d090176 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,20 @@
+
+
+---
+
+[![Button Install]][Install]
+[![Button Activate]][Activate]
+[![Button Update]][Update]
+
+---
+
+
+
+
+
## Readings
- ***Temperature***
@@ -71,9 +85,19 @@ of **ZenPower** to help future development efforts.
[Badge License]: https://img.shields.io/badge/License-GPL_2-blue.svg?style=for-the-badge
+[Activate]: Documentation/Activate.md
+[Install]: Documentation/Install.md
[License]: LICENSE
+[Update]: Documentation/Update.md
[Share Debug Data]: https://github.com/ocerman/zenpower/issues/12
[ZenMonitor]: https://github.com/ocerman/zenmonitor
[Patched]: https://patchwork.kernel.org/patch/11043277/
[#23]: https://github.com/ocerman/zenpower/issues/23
+
+
+
+
+[Button Activate]: https://img.shields.io/badge/Activate-cdad0d?style=for-the-badge
+[Button Install]: https://img.shields.io/badge/Install-df6195?style=for-the-badge
+[Button Update]: https://img.shields.io/badge/Update-2ba4ab?style=for-the-badge
From 99675953c3b40f83fc9de994e91caf5f795848f2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?=
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Mon, 23 May 2022 10:09:46 -0400
Subject: [PATCH 10/17] Fixed Wording
---
Documentation/Activate.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/Activate.md b/Documentation/Activate.md
index a6e41a8..b901cf5 100644
--- a/Documentation/Activate.md
+++ b/Documentation/Activate.md
@@ -1,8 +1,8 @@
# Activation
-Because **ZenPower** is using same **PCI** device
-as **[k10temp]**, you have to disable it first.
+As **ZenPower** is using the same **PCI** device
+as **[k10temp]**, you will need to disable it first.
@@ -46,4 +46,4 @@ as **[k10temp]**, you have to disable it first.
-[k10temp]: https://github.com/groeck/k10temp
\ No newline at end of file
+[k10temp]: https://github.com/groeck/k10temp
From 5a02876ee1b20e8192d347b19580b0c559910bb1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?=
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Mon, 23 May 2022 10:11:33 -0400
Subject: [PATCH 11/17] Adjusted Spacing
---
Documentation/Update.md | 28 +++++++++++++++++++++++++---
1 file changed, 25 insertions(+), 3 deletions(-)
diff --git a/Documentation/Update.md b/Documentation/Update.md
index fc2bbe1..5f94d27 100644
--- a/Documentation/Update.md
+++ b/Documentation/Update.md
@@ -5,38 +5,60 @@
1. Unload **ZenPower**:
+
+
```sh
sudo modprobe -r zenpower
```
+
+
2. Navigate to its folder:
+
+
```sh
cd ~/zenpower
```
+
+
3. Uninstall the old version:
+
+
```sh
sudo make dkms-uninstall
```
-4. Update the code from git
+
+
+4. Update the code from git:
+
+
```
git pull
```
+
+
5. Install the new version:
+
+
```
sudo make dkms-install
```
+
+
6. Activate **Zenpower**:
+
+
```
sudo modprobe zenpower
```
-
-
\ No newline at end of file
+
+
From 750c4fb86b4ca0869aef66423d76ae1b7a9dc5c3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?=
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Mon, 23 May 2022 10:14:02 -0400
Subject: [PATCH 12/17] Adjusted Wording
---
Documentation/Activate.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/Activate.md b/Documentation/Activate.md
index b901cf5..8c9ed60 100644
--- a/Documentation/Activate.md
+++ b/Documentation/Activate.md
@@ -30,8 +30,8 @@ as **[k10temp]**, you will need to disable it first.
#### Optional
- *If **[k10temp]** is not blacklisted, you may have to*
- *manually unload k10temp after each restart.*
+ *If **[k10temp]** is not blacklisted, you may have*
+ *to manually unload it after every restart.*
From 241d9743d4b3c9f604b64c95db4dee4390ae9717 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?=
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Mon, 23 May 2022 10:15:21 -0400
Subject: [PATCH 13/17] Adjusted Style
---
README.md | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index d090176..387ee41 100644
--- a/README.md
+++ b/README.md
@@ -34,17 +34,17 @@
- Your **Linux Kernel** must support your **CPU**.
***ZenPower*** *reads values from **SMN** with*
- *the kernel function:* `amd_smn_read`
+ *the kernel function:* `amd_smn_read`
*There is a fallback, however*
*it is not guaranteed to work.*
-- `AMD Ryzen 3000` CPUs
+- `AMD Ryzen 3000` CPUs
- Family: `17h`
- Model: `70h`
+ Family: `17h`
+ Model: `70h`
- Require a `5.3.4+` kernel or a **[Patched]** one.
+ Require a `5.3.4+` kernel or a **[Patched]** one.
@@ -72,7 +72,7 @@ of **ZenPower** to help future development efforts.
was necessary after module installation.
- If you are having trouble compiling **ZenPower** under
- `Ubuntu 18.04+` with new upstream kernel, see [#23].
+ `Ubuntu 18.04+` with new upstream kernel, see **[#23]**.
- The meaning of raw current values from **SVI2**
telemetry are not standardized so the current
From 6021ba13c545475d8c4652555c61081350e60218 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?=
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Wed, 3 Aug 2022 10:42:33 -0400
Subject: [PATCH 14/17] Adjusted Formatting
---
README.md | 21 +++++++++++----------
1 file changed, 11 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 387ee41..66a748c 100644
--- a/README.md
+++ b/README.md
@@ -3,20 +3,18 @@
*Linux kernel Driver AMD Zen Family CPUs*
+
----
-
[![Button Install]][Install]
[![Button Activate]][Activate]
[![Button Update]][Update]
----
-
+
## Readings
@@ -83,20 +81,23 @@ of **ZenPower** to help future development efforts.
-[Badge License]: https://img.shields.io/badge/License-GPL_2-blue.svg?style=for-the-badge
+[Share Debug Data]: https://github.com/ocerman/zenpower/issues/12
+[ZenMonitor]: https://github.com/ocerman/zenmonitor
+[Patched]: https://patchwork.kernel.org/patch/11043277/
+[#23]: https://github.com/ocerman/zenpower/issues/23
[Activate]: Documentation/Activate.md
[Install]: Documentation/Install.md
[License]: LICENSE
[Update]: Documentation/Update.md
-[Share Debug Data]: https://github.com/ocerman/zenpower/issues/12
-[ZenMonitor]: https://github.com/ocerman/zenmonitor
-[Patched]: https://patchwork.kernel.org/patch/11043277/
-[#23]: https://github.com/ocerman/zenpower/issues/23
+
-
+[Badge License]: https://img.shields.io/badge/License-GPL2-015d93.svg?style=for-the-badge&labelColor=blue
+
+
+
[Button Activate]: https://img.shields.io/badge/Activate-cdad0d?style=for-the-badge
[Button Install]: https://img.shields.io/badge/Install-df6195?style=for-the-badge
From ef45b6420ec28bacfcf9b7f7a563652dbfdcccc7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?=
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Wed, 3 Aug 2022 10:43:02 -0400
Subject: [PATCH 15/17] Adjusted Spacing
---
README.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/README.md b/README.md
index 66a748c..ccd5cf9 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,7 @@
*Linux kernel Driver AMD Zen Family CPUs*
+
@@ -77,6 +78,7 @@ of **ZenPower** to help future development efforts.
and power readings may not be accurate on
all systems (depends on the board model).
+
From d97822a1c180734b0a5f24db33d688640872ce42 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?=
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Wed, 3 Aug 2022 10:45:37 -0400
Subject: [PATCH 16/17] Adjusted Quicklinks
---
README.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index ccd5cf9..7baa794 100644
--- a/README.md
+++ b/README.md
@@ -101,6 +101,6 @@ of **ZenPower** to help future development efforts.
-[Button Activate]: https://img.shields.io/badge/Activate-cdad0d?style=for-the-badge
-[Button Install]: https://img.shields.io/badge/Install-df6195?style=for-the-badge
-[Button Update]: https://img.shields.io/badge/Update-2ba4ab?style=for-the-badge
+[Button Activate]: https://img.shields.io/badge/Activate-cdad0d?style=for-the-badge&logoColor=white&logo=Lumen
+[Button Install]: https://img.shields.io/badge/Install-df6195?style=for-the-badge&logoColor=white&logo=DocuSign
+[Button Update]: https://img.shields.io/badge/Update-2ba4ab?style=for-the-badge&logoColor=white&logo=MLflow
From f96e3119702ba36b8769cdd3306df620703276f3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?=
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Wed, 3 Aug 2022 10:46:51 -0400
Subject: [PATCH 17/17] Adjusted Installation
---
Documentation/Install.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/Install.md b/Documentation/Install.md
index c52254a..cec29c6 100644
--- a/Documentation/Install.md
+++ b/Documentation/Install.md
@@ -1,7 +1,7 @@
# Installation
-*You can install this module via `dkms` .*
+*You can install this module via `dkms` .*
@@ -28,4 +28,4 @@ sudo make dkms-install
-[Badge Ubuntu]: https://img.shields.io/badge/Ubuntu-E95420?style=for-the-badge
\ No newline at end of file
+[Badge Ubuntu]: https://img.shields.io/badge/Ubuntu-E95420?style=for-the-badge&logoColor=white&logo=Ubuntu