Skip to content

Commit a3e7ce1

Browse files
committed
docs: launch-ready README (demo GIF, install buttons, comparison, FAQ)
1 parent e2eb18f commit a3e7ce1

2 files changed

Lines changed: 74 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 74 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div align="center">
22
<img src="assets/icons/ico.ico" alt="ThreadPilot app icon" width="128">
33
<h1>ThreadPilot ✈️</h1>
4-
<p><strong>A free, open-source Windows process control center for deterministic CPU, priority, memory and power-plan workflows.</strong></p>
4+
<p><strong>Free, open-source CPU scheduling control for Windows 11: CPU Sets, priorities and saved rules, with no limits or nags.</strong><br>Built for the CPUs where scheduling matters: Intel hybrid and AMD X3D / multi-CCD.</p>
55
<p>
66
<a href="https://github.com/PrimeBuild-pc/ThreadPilot/commits/main"><img alt="Last commit" src="https://img.shields.io/github/last-commit/PrimeBuild-pc/ThreadPilot?style=plastic&amp;logo=git&amp;logoColor=white"></a>
77
<a href="https://github.com/PrimeBuild-pc/ThreadPilot/stargazers"><img alt="GitHub stars" src="https://img.shields.io/github/stars/PrimeBuild-pc/ThreadPilot?style=plastic&amp;logo=github"></a>
@@ -21,10 +21,19 @@
2121
<a href="Locales/"><img alt="Seven interface languages" src="https://img.shields.io/badge/UI%20languages-7-5B5FC7?style=plastic&amp;logo=googletranslate&amp;logoColor=white"></a>
2222
<a href="LICENSE"><img alt="AGPL v3 license" src="https://img.shields.io/badge/license-AGPLv3-2ea44f?style=plastic"></a>
2323
</p>
24-
<p><a href="#-install">Install</a> · <a href="#-features">Features</a> · <a href="#-screenshots">Screenshots</a> · <a href="#-build-from-source">Build</a> · <a href="#-support-the-project">Support</a></p>
24+
<p>
25+
<a href="https://github.com/PrimeBuild-pc/ThreadPilot/releases/latest"><img alt="Download the latest release" src="https://img.shields.io/badge/Download-Latest%20release-2ea44f?style=for-the-badge&amp;logo=github"></a>
26+
<a href="#install-with-winget"><img alt="Install with WinGet" src="https://img.shields.io/badge/WinGet-PrimeBuild.ThreadPilot-0078D4?style=for-the-badge&amp;logo=windows&amp;logoColor=white"></a>
27+
<a href="#install-with-chocolatey"><img alt="Install with Chocolatey" src="https://img.shields.io/badge/Chocolatey-threadpilot-80B5E3?style=for-the-badge&amp;logo=chocolatey&amp;logoColor=white"></a>
28+
</p>
29+
<p><a href="#-install">Install</a> · <a href="#-features">Features</a> · <a href="#-how-it-compares">How it compares</a> · <a href="#-screenshots">Screenshots</a> · <a href="#-faq">FAQ</a> · <a href="#-build-from-source">Build</a> · <a href="#-support-the-project">Support</a></p>
2530

2631
</div>
2732

33+
<p align="center"><img src="docs/media/threadpilot-demo.gif" alt="ThreadPilot demo: CPU masks, saved rules, activity log and Windows tweaks" width="860"></p>
34+
35+
<p align="center"><sub>Real screen recording of v1.7.9: CPU masks, saved rules, Activity and Tweaks.</sub></p>
36+
2837
<a href="assets/screenshots/overview-themes.png"><img width="1600" height="960" alt="ThreadPilot 1.7.8-beta.1: the current Processes interface in dark and light themes" src="assets/screenshots/overview-themes.png"></a>
2938

3039
<p align="center"><sub>Real dark/light screenshots of the interface. <a href="assets/screenshots/processes-dark.png">View dark</a> · <a href="assets/screenshots/processes-light.png">View light</a></sub></p>
@@ -35,6 +44,27 @@ ThreadPilot is a modern Windows process control center for users who want predic
3544

3645
It is designed as an open-source alternative for power users who need Process Lasso-style capabilities, automation support, system tray controls, and a Windows 11-first experience. ThreadPilot is not a performance overlay: its primary job is applying explicit process controls safely and making the result visible.
3746

47+
## ⚖️ How it compares
48+
49+
ThreadPilot started as an open-source alternative to [Process Lasso](https://bitsum.com/). Here is the honest version of how they differ. Check each product's own site for its current features and pricing.
50+
51+
**What ThreadPilot does**
52+
53+
- Open source (AGPL-3.0) and free, with no feature limits and no nag screens. The code is here, so you can check.
54+
- CPU Sets support and topology-aware core selection, including processor groups and more than 64 logical processors; Intel hybrid handling comes from Windows topology (`EfficiencyClass`), not hardcoded CPU lists.
55+
- Saved rules are shown in an editor you can read, and every change lands in an Activity log with filters and export.
56+
- Windows 11 Fluent interface, seven UI languages, plus a Tweaks page for a few basic Windows performance settings.
57+
- No telemetry ([`PRIVACY.md`](docs/PRIVACY.md)). Updated through WinGet and Chocolatey.
58+
59+
**What it does not do (yet)**
60+
61+
- It applies the rules you set. It has no automatic responsiveness management like Process Lasso's ProBalance.
62+
- Saved rules apply only while ThreadPilot is running: no Windows service, no registry or IFEO persistence.
63+
- Windows 11 only (build 22000 or newer), and it always asks for administrator rights.
64+
- Releases are unsigned for now, so SmartScreen may warn ([details](#-faq)).
65+
- Game Boost is still unvalidated on real dual-CCD Ryzen and Intel hybrid CPUs.
66+
- Process Lasso is the older, more established tool with a much longer track record. ThreadPilot is younger and moves fast.
67+
3868
## ✨ Features
3969

4070
- Live process management with refresh, filtering, context-menu actions, and a selected-process summary.
@@ -90,7 +120,7 @@ choco upgrade threadpilot
90120
### Download from GitHub Releases
91121

92122
[![Download Latest Stable](https://img.shields.io/badge/Download-Latest%20Stable-2ea44f?logo=github)](https://github.com/PrimeBuild-pc/ThreadPilot/releases/latest)
93-
**Stable v1.7.8 includes Game Boost** (off by default). It is not yet validated on real dual-CCD Ryzen and Intel hybrid CPUs; if you have one, see the [test steps and issue-reporting checklist](docs/releases/v1.7.8.md#help-us-test-dual-ccd-ryzen-and-intel-hybrid).
123+
**Stable releases include Game Boost** (off by default). It is not yet validated on real dual-CCD Ryzen and Intel hybrid CPUs; if you have one, see the [test steps and issue-reporting checklist](docs/releases/v1.7.8.md#help-us-test-dual-ccd-ryzen-and-intel-hybrid).
94124

95125
Both channels use the same application/settings location. Export a configuration backup before switching; they are not separate side-by-side installations.
96126

@@ -131,6 +161,47 @@ Captured from the official **v1.7.8-beta.1** installer in a Windows 11 test VM,
131161
</tr>
132162
</table>
133163

164+
## ❓ FAQ
165+
166+
<details>
167+
<summary><strong>Windows SmartScreen warns me when I run the installer. Is it safe?</strong></summary>
168+
169+
Releases are currently unsigned, so SmartScreen may warn on first launch. A free code-signing application with SignPath Foundation is pending. Until then, compare the file's SHA-256 with `SHA256SUMS.txt` on the same release page (commands in [Install](#download-from-github-releases)), and only then use **More info → Run anyway**. The code is public and CI builds the releases. See [`docs/TROUBLESHOOTING.md`](docs/TROUBLESHOOTING.md).
170+
</details>
171+
172+
<details>
173+
<summary><strong>Why does it need administrator rights?</strong></summary>
174+
175+
The app manifest requests elevation so ThreadPilot can change settings of other processes. If you decline the UAC prompt, the app exits instead of running in a limited mode.
176+
</details>
177+
178+
<details>
179+
<summary><strong>Will it get me banned by an anti-cheat?</strong></summary>
180+
181+
ThreadPilot uses standard Windows APIs (CPU Sets, priority, EcoQoS) and does not inject into other processes. It does not bypass anti-cheat or protected-process restrictions, and we have not tested it against specific anti-cheat systems. If a game's rules forbid touching its process, leave that game alone: the Game Boost feature is off by default for this reason too.
182+
</details>
183+
184+
<details>
185+
<summary><strong>How do I undo a change?</strong></summary>
186+
187+
- **A process change:** on the Processes page, use **Undo last change**.
188+
- **A saved rule:** disable or delete it on the Rules page.
189+
- **Game Boost:** turn it off in Tweaks. It also restores its changes when the game closes.
190+
- **Everything:** priority, CPU Sets and efficiency mode set on a running process do not survive the process exiting. Use **Settings → Export Configuration** before big changes to keep a backup.
191+
</details>
192+
193+
<details>
194+
<summary><strong>Does it keep working when ThreadPilot is closed?</strong></summary>
195+
196+
No. Saved rules apply only while ThreadPilot is running. It installs no Windows service and writes no registry or IFEO persistence. Use the tray icon and the `--start-minimized` / `--autostart` arguments to keep it in the background.
197+
</details>
198+
199+
<details>
200+
<summary><strong>Does it collect data?</strong></summary>
201+
202+
No analytics or telemetry. See [`docs/PRIVACY.md`](docs/PRIVACY.md).
203+
</details>
204+
134205
## ⚙️ Requirements
135206

136207
- Windows 11, build 22000 or newer.

‎docs/media/threadpilot-demo.gif‎

1.18 MB
Loading

0 commit comments

Comments
 (0)