doc: add quick links to README, update config reference

This commit is contained in:
Ilya Zlobintsev
2025-03-17 08:13:11 +02:00
parent baa0b98c95
commit a65beb4e0e
3 changed files with 38 additions and 17 deletions
+31 -11
View File
@@ -20,6 +20,14 @@ Current features:
All of the functionality works regardless of the desktop session (there is no dependency on X11 extensions).
# Quick links
- [Installation](#installation)
- [Hardware support](https://github.com/ilya-zlobintsev/LACT/wiki/Hardware-Support)
- [Enable overclocking on AMD](https://github.com/ilya-zlobintsev/LACT/wiki/Overclocking-(AMD))
- [Config file reference](./docs/CONFIG.md)
- [API](./docs/API.md)
- [Power profiles daemon conflict](#power-profiles-daemon-note)
# Installation
- Arch Linux: Install the package from official repositories: `pacman -S lact` (or `lact-git` from AUR for development builds).
@@ -87,6 +95,8 @@ To avoid this, create a file at `/etc/systemd/system/power-profiles-daemon.servi
ExecStart=
ExecStart=/usr/libexec/power-profiles-daemon --block-action=amdgpu_dpm
```
Note: the `/usr/libexec` path might be different on your system, check it in `systemctl status power-profiles-daemon`
See https://github.com/ilya-zlobintsev/LACT/issues/370 for more information.
# Suspend/Resume
@@ -104,6 +114,7 @@ Dependencies:
- make
- hwdata
- libdrm
- vulkan-tools
Command to install all dependencies:
- Fedora: `sudo dnf install rust cargo make git clang gtk4-devel libdrm-devel vulkan-tools`
@@ -127,10 +138,6 @@ Build GUI with libadwaita support:
make build-release-libadwaita
```
# API
There is an API available over a unix or TCP socket. See [here](docs/API.md) for more information.
# Remote management
It's possible to have the LACT daemon running on one machine, and then manage it remotely from another.
@@ -166,7 +173,7 @@ There is also a cli available.
Example output:
```
1002:687F-1043:0555-0000:0b:00.0 (Vega 10 XL/XT [Radeon RX Vega 56/64])
10DE:2704-1462:5110-0000:09:00.0 (AD103 [GeForce RTX 4080])
```
- Getting GPU information:
@@ -175,12 +182,25 @@ There is also a cli available.
Example output:
```
lact cli info
GPU Vendor: Advanced Micro Devices, Inc. [AMD/ATI]
GPU Model: Vega 10 XL/XT [Radeon RX Vega 56/64]
Driver in use: amdgpu
VBIOS version: 115-D050PIL-100
Link: LinkInfo { current_width: Some("16"), current_speed: Some("8.0 GT/s PCIe"), max_width: Some("16"), max_speed: Some("8.0 GT/s PCIe") }
$ lact cli info
GPU 10DE:2704-1462:5110-0000:09:00.0:
=====================================
GPU Model: NVIDIA GeForce RTX 4080 (0x10DE:0x2704)
Card Manufacturer: Micro-Star International Co., Ltd. [MSI] (0x1462)
Card Model: Unknown (0x5110)
Driver Used: nvidia 570.124.04
VBIOS Version: 95.03.1E.00.60
VRAM Size: 16376 MiB
GPU Family: Ada
Cuda Cores: 9728
SM Count: 76
ROP Count: 112 (14 * 8)
VRAM Type: GDDR6x
VRAM Manufacturer: Micron
L2 Cache: 65536 KiB
Resizeable bar: Enabled
CPU Accessible VRAM: 16384
Link Speed: 8 GT/s PCIe gen 3 x8
```
The functionality of the CLI is quite limited. If you want to integrate LACT with some application/script, you should use the [API](API.md) instead.