Skip to content

Commit 9b965d5

Browse files
committed
docs(readme): enrich documentation
- Add project overview, feature list, installation and usage instructions - Include logo and demo screenshot
1 parent 7906d1f commit 9b965d5

4 files changed

Lines changed: 36 additions & 0 deletions

File tree

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<div align="center">
2+
<img alt="logo" src="assets/logo.png">
3+
<br>
4+
A lightweight Windows utility that <b>alerts you when your AMD GPU overheats</b><br>Perfect for older cards like the RX 550 where the fan may silently stop 🫠
5+
<br><br>
6+
<b>
7+
<a href="#-features">Features</a>&nbsp; •&nbsp;
8+
<a href="#-installation">Installation</a>&nbsp; •&nbsp;
9+
<a href="#%EF%B8%8F-usage">Usage</a>
10+
</b>
11+
<br><br>
12+
<img alt="demo" src="assets/demo.png">
13+
</div>
14+
15+
## 🔥 Features
16+
17+
- Monitors GPU state and triggers alerts on overheating
18+
- Detects fan failures (zero RPM under load)
19+
- Configurable temperature thresholds
20+
- Background service with Windows startup support
21+
22+
## 📥 Installation
23+
24+
Download the [latest release](https://github.com/kh4f/amdalert/releases/latest) and extract it anywhere.
25+
26+
## 🕹️ Usage
27+
28+
- Control the app via CLI (`AMDAlert.exe`).
29+
- Configuration is stored in `settings.json` (created automatically on first run). You can edit it manually or via CLI commands.
30+
- Enabling alerts starts a background service (`AMDAlertDaemon.exe`) that checks the GPU state every 10 sec and shows notifications when needed.
31+
32+
</br>
33+
34+
<div align="center">
35+
<b>MIT License © 2026 <a href="https://github.com/kh4f">kh4f</a></b>
36+
</div>

assets/demo.png

-12.6 KB
Loading

assets/icon.ico

0 Bytes
Binary file not shown.

assets/logo.png

6.03 KB
Loading

0 commit comments

Comments
 (0)