Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Lurkki14 committed May 25, 2019
1 parent 1593f5b commit 51c5942
Showing 1 changed file with 45 additions and 8 deletions.
53 changes: 45 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
TuxClocker - A GUI overclocking utility for GNU/Linux
========================================
TuxClocker is a Qt5 overclocking tool. Currently supported cards are nvidia 600-series cards and newer. Support for AMD GPUs is planned.
TuxClocker is a Qt5 overclocking tool. Currently supported cards are nvidia 600-series cards and newer, and AMD GPUs using the amdgpu driver until (not including) Radeon VII.

# Screenshots

Expand All @@ -11,24 +11,26 @@ TuxClocker is a Qt5 overclocking tool. Currently supported cards are nvidia 600-
- Overclocking
- Overvolting
- Change power limit
- (AMD) pstate editing
- Fan mode selection
- Custom fan curve
- Provisional multi-GPU support
- Profiles

# Features in development
- AMD support

# Requirements
# Requirements (nvidia)
- NOTE: headers are usually included in a package named \*-dev, if they are separate
- nvidia-smi
- nvidia-settings
- libxnvctrl and headers (if not included in nvidia-settings)
- Qt 5 base libraries and x11extras
- Coolbits set to the value you want (31 for all functionality)
- qt5base, x11extras and their headers
- [Coolbits](https://wiki.archlinux.org/index.php/NVIDIA/Tips_and_tricks#Enabling_overclocking) set to the value you want (31 for all functionality)

# Installation
# Installation (nvidia)

### Compilation

NOTE: on some systems, qmake is linked to qt4-qmake. If qmake fails, run qmake-qt5 in place of qmake

```
git clone https://github.com/Lurkki14/tuxclocker
cd tuxclocker
Expand All @@ -40,5 +42,40 @@ make install (installs into /opt/tuxclocker/bin)
#### AUR package
[https://aur.archlinux.org/packages/tuxclocker/](https://aur.archlinux.org/packages/tuxclocker/)

# Requirements (AMD)

- NOTE: headers are usually included in a package named \*-dev, if they are separate
- libdrm and headers
- amdgpu.ppfeaturemask boot paramter set to the value you want. To view the current value, run

```
printf "0x%08x\n" $(cat /sys/module/amdgpu/parameters/ppfeaturemask)
```


Example grub line (usually /etc/default/grub):

```
GRUB_CMDLINE_LINUX_DEFAULT="quiet radeon.si_support=0 amdgpu.si_support=1 amdgpu.dpm=1 amdgpu.ppfeaturemask=0xffffffff"
```

After editing, update grub, usually
```
sudo update-grub
```

# Installation (AMD)

### Compilation

NOTE: on some, systems, qmake is linked to qt4-qmake. If qmake fails, run qmake-qt5 in place of qmake

```
git clone https://github.com/Lurkki14/tuxclocker
cd tuxclocker
git checkout pstatetest
qmake rojekti.pro
make
make install (installs into /opt/tuxclocker/bin)
```
NOTE: to use fancurves on the AMD version, you need to run as root.

0 comments on commit 51c5942

Please sign in to comment.